]> git.ipfire.org Git - thirdparty/systemd.git/blob - src/tmpfiles/tmpfiles.c
projects / thirdparty / systemd.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
tests: reflect that we can now handle devices with very long sysfs paths
[thirdparty/systemd.git] / src / tmpfiles / tmpfiles.c
1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
2
3 #include <errno.h>
4 #include <fcntl.h>
5 #include <fnmatch.h>
6 #include <getopt.h>
7 #include <limits.h>
8 #include <linux/fs.h>
9 #include <stdbool.h>
10 #include <stddef.h>
11 #include <stdlib.h>
12 #include <sys/file.h>
13 #include <sys/xattr.h>
14 #include <sysexits.h>
15 #include <time.h>
16 #include <unistd.h>
17
18 #include "sd-path.h"
19
20 #include "acl-util.h"
21 #include "alloc-util.h"
22 #include "btrfs-util.h"
23 #include "capability-util.h"
24 #include "chase-symlinks.h"
25 #include "chattr-util.h"
26 #include "conf-files.h"
27 #include "copy.h"
28 #include "def.h"
29 #include "dirent-util.h"
30 #include "dissect-image.h"
31 #include "env-util.h"
32 #include "escape.h"
33 #include "fd-util.h"
34 #include "fileio.h"
35 #include "format-util.h"
36 #include "fs-util.h"
37 #include "glob-util.h"
38 #include "io-util.h"
39 #include "label.h"
40 #include "log.h"
41 #include "macro.h"
42 #include "main-func.h"
43 #include "missing_stat.h"
44 #include "missing_syscall.h"
45 #include "mkdir-label.h"
46 #include "mount-util.h"
47 #include "mountpoint-util.h"
48 #include "offline-passwd.h"
49 #include "pager.h"
50 #include "parse-argument.h"
51 #include "parse-util.h"
52 #include "path-lookup.h"
53 #include "path-util.h"
54 #include "pretty-print.h"
55 #include "rlimit-util.h"
56 #include "rm-rf.h"
57 #include "selinux-util.h"
58 #include "set.h"
59 #include "sort-util.h"
60 #include "specifier.h"
61 #include "stat-util.h"
62 #include "stdio-util.h"
63 #include "string-table.h"
64 #include "string-util.h"
65 #include "strv.h"
66 #include "terminal-util.h"
67 #include "umask-util.h"
68 #include "user-util.h"
69
70 /* This reads all files listed in /etc/tmpfiles.d/?*.conf and creates
71 * them in the file system. This is intended to be used to create
72 * properly owned directories beneath /tmp, /var/tmp, /run, which are
73 * volatile and hence need to be recreated on bootup. */
74
75 typedef enum OperationMask {
76 OPERATION_CREATE = 1 << 0,
77 OPERATION_REMOVE = 1 << 1,
78 OPERATION_CLEAN = 1 << 2,
79 } OperationMask;
80
81 typedef enum ItemType {
82 /* These ones take file names */
83 CREATE_FILE = 'f',
84 TRUNCATE_FILE = 'F', /* deprecated: use f+ */
85 CREATE_DIRECTORY = 'd',
86 TRUNCATE_DIRECTORY = 'D',
87 CREATE_SUBVOLUME = 'v',
88 CREATE_SUBVOLUME_INHERIT_QUOTA = 'q',
89 CREATE_SUBVOLUME_NEW_QUOTA = 'Q',
90 CREATE_FIFO = 'p',
91 CREATE_SYMLINK = 'L',
92 CREATE_CHAR_DEVICE = 'c',
93 CREATE_BLOCK_DEVICE = 'b',
94 COPY_FILES = 'C',
95
96 /* These ones take globs */
97 WRITE_FILE = 'w',
98 EMPTY_DIRECTORY = 'e',
99 SET_XATTR = 't',
100 RECURSIVE_SET_XATTR = 'T',
101 SET_ACL = 'a',
102 RECURSIVE_SET_ACL = 'A',
103 SET_ATTRIBUTE = 'h',
104 RECURSIVE_SET_ATTRIBUTE = 'H',
105 IGNORE_PATH = 'x',
106 IGNORE_DIRECTORY_PATH = 'X',
107 REMOVE_PATH = 'r',
108 RECURSIVE_REMOVE_PATH = 'R',
109 RELABEL_PATH = 'z',
110 RECURSIVE_RELABEL_PATH = 'Z',
111 ADJUST_MODE = 'm', /* legacy, 'z' is identical to this */
112 } ItemType;
113
114 typedef enum AgeBy {
115 AGE_BY_ATIME = 1 << 0,
116 AGE_BY_BTIME = 1 << 1,
117 AGE_BY_CTIME = 1 << 2,
118 AGE_BY_MTIME = 1 << 3,
119
120 /* All file timestamp types are checked by default. */
121 AGE_BY_DEFAULT_FILE = AGE_BY_ATIME | AGE_BY_BTIME | AGE_BY_CTIME | AGE_BY_MTIME,
122 AGE_BY_DEFAULT_DIR = AGE_BY_ATIME | AGE_BY_BTIME | AGE_BY_MTIME
123 } AgeBy;
124
125 typedef struct Item {
126 ItemType type;
127
128 char *path;
129 char *argument;
130 char **xattrs;
131 #if HAVE_ACL
132 acl_t acl_access;
133 acl_t acl_default;
134 #endif
135 uid_t uid;
136 gid_t gid;
137 mode_t mode;
138 usec_t age;
139 AgeBy age_by_file, age_by_dir;
140
141 dev_t major_minor;
142 unsigned attribute_value;
143 unsigned attribute_mask;
144
145 bool uid_set:1;
146 bool gid_set:1;
147 bool mode_set:1;
148 bool age_set:1;
149 bool mask_perms:1;
150 bool attribute_set:1;
151
152 bool keep_first_level:1;
153
154 bool append_or_force:1;
155
156 bool allow_failure:1;
157
158 bool try_replace:1;
159
160 OperationMask done;
161 } Item;
162
163 typedef struct ItemArray {
164 Item *items;
165 size_t n_items;
166
167 struct ItemArray *parent;
168 Set *children;
169 } ItemArray;
170
171 typedef enum DirectoryType {
172 DIRECTORY_RUNTIME,
173 DIRECTORY_STATE,
174 DIRECTORY_CACHE,
175 DIRECTORY_LOGS,
176 _DIRECTORY_TYPE_MAX,
177 } DirectoryType;
178
179 static bool arg_cat_config = false;
180 static bool arg_user = false;
181 static OperationMask arg_operation = 0;
182 static bool arg_boot = false;
183 static PagerFlags arg_pager_flags = 0;
184
185 static char **arg_include_prefixes = NULL;
186 static char **arg_exclude_prefixes = NULL;
187 static char *arg_root = NULL;
188 static char *arg_image = NULL;
189 static char *arg_replace = NULL;
190
191 #define MAX_DEPTH 256
192
193 static OrderedHashmap *items = NULL, *globs = NULL;
194 static Set *unix_sockets = NULL;
195
196 STATIC_DESTRUCTOR_REGISTER(items, ordered_hashmap_freep);
197 STATIC_DESTRUCTOR_REGISTER(globs, ordered_hashmap_freep);
198 STATIC_DESTRUCTOR_REGISTER(unix_sockets, set_freep);
199 STATIC_DESTRUCTOR_REGISTER(arg_include_prefixes, freep);
200 STATIC_DESTRUCTOR_REGISTER(arg_exclude_prefixes, freep);
201 STATIC_DESTRUCTOR_REGISTER(arg_root, freep);
202 STATIC_DESTRUCTOR_REGISTER(arg_image, freep);
203
204 static int specifier_machine_id_safe(char specifier, const void *data, const char *root, const void *userdata, char **ret);
205 static int specifier_directory(char specifier, const void *data, const char *root, const void *userdata, char **ret);
206
207 static int specifier_machine_id_safe(char specifier, const void *data, const char *root, const void *userdata, char **ret) {
208 int r;
209
210 /* If /etc/machine_id is missing or empty (e.g. in a chroot environment) return a recognizable error
211 * so that the caller can skip the rule gracefully. */
212
213 r = specifier_machine_id(specifier, data, root, userdata, ret);
214 if (IN_SET(r, -ENOENT, -ENOMEDIUM))
215 return -ENXIO;
216
217 return r;
218 }
219
220 static int specifier_directory(char specifier, const void *data, const char *root, const void *userdata, char **ret) {
221 struct table_entry {
222 uint64_t type;
223 const char *suffix;
224 };
225
226 static const struct table_entry paths_system[] = {
227 [DIRECTORY_RUNTIME] = { SD_PATH_SYSTEM_RUNTIME },
228 [DIRECTORY_STATE] = { SD_PATH_SYSTEM_STATE_PRIVATE },
229 [DIRECTORY_CACHE] = { SD_PATH_SYSTEM_STATE_CACHE },
230 [DIRECTORY_LOGS] = { SD_PATH_SYSTEM_STATE_LOGS },
231 };
232
233 static const struct table_entry paths_user[] = {
234 [DIRECTORY_RUNTIME] = { SD_PATH_USER_RUNTIME },
235 [DIRECTORY_STATE] = { SD_PATH_USER_CONFIGURATION },
236 [DIRECTORY_CACHE] = { SD_PATH_USER_STATE_CACHE },
237 [DIRECTORY_LOGS] = { SD_PATH_USER_CONFIGURATION, "log" },
238 };
239
240 const struct table_entry *paths;
241 _cleanup_free_ char *p = NULL;
242 unsigned i;
243 int r;
244
245 assert_cc(ELEMENTSOF(paths_system) == ELEMENTSOF(paths_user));
246 paths = arg_user ? paths_user : paths_system;
247
248 i = PTR_TO_UINT(data);
249 assert(i < ELEMENTSOF(paths_system));
250
251 r = sd_path_lookup(paths[i].type, paths[i].suffix, &p);
252 if (r < 0)
253 return r;
254
255 if (arg_root) {
256 _cleanup_free_ char *j = NULL;
257
258 j = path_join(arg_root, p);
259 if (!j)
260 return -ENOMEM;
261
262 *ret = TAKE_PTR(j);
263 } else
264 *ret = TAKE_PTR(p);
265
266 return 0;
267 }
268
269 static int log_unresolvable_specifier(const char *filename, unsigned line) {
270 static bool notified = false;
271
272 /* In system mode, this is called when /etc is not fully initialized (e.g.
273 * in a chroot environment) where some specifiers are unresolvable. In user
274 * mode, this is called when some variables are not defined. These cases are
275 * not considered as an error so log at LOG_NOTICE only for the first time
276 * and then downgrade this to LOG_DEBUG for the rest. */
277
278 log_syntax(NULL,
279 notified ? LOG_DEBUG : LOG_NOTICE,
280 filename, line, 0,
281 "Failed to resolve specifier: %s, skipping",
282 arg_user ? "Required $XDG_... variable not defined" : "uninitialized /etc detected");
283
284 if (!notified)
285 log_notice("All rules containing unresolvable specifiers will be skipped.");
286
287 notified = true;
288 return 0;
289 }
290
291 static int user_config_paths(char*** ret) {
292 _cleanup_strv_free_ char **config_dirs = NULL, **data_dirs = NULL;
293 _cleanup_free_ char *persistent_config = NULL, *runtime_config = NULL, *data_home = NULL;
294 _cleanup_strv_free_ char **res = NULL;
295 int r;
296
297 r = xdg_user_dirs(&config_dirs, &data_dirs);
298 if (r < 0)
299 return r;
300
301 r = xdg_user_config_dir(&persistent_config, "/user-tmpfiles.d");
302 if (r < 0 && r != -ENXIO)
303 return r;
304
305 r = xdg_user_runtime_dir(&runtime_config, "/user-tmpfiles.d");
306 if (r < 0 && r != -ENXIO)
307 return r;
308
309 r = xdg_user_data_dir(&data_home, "/user-tmpfiles.d");
310 if (r < 0 && r != -ENXIO)
311 return r;
312
313 r = strv_extend_strv_concat(&res, config_dirs, "/user-tmpfiles.d");
314 if (r < 0)
315 return r;
316
317 r = strv_extend(&res, persistent_config);
318 if (r < 0)
319 return r;
320
321 r = strv_extend(&res, runtime_config);
322 if (r < 0)
323 return r;
324
325 r = strv_extend(&res, data_home);
326 if (r < 0)
327 return r;
328
329 r = strv_extend_strv_concat(&res, data_dirs, "/user-tmpfiles.d");
330 if (r < 0)
331 return r;
332
333 r = path_strv_make_absolute_cwd(res);
334 if (r < 0)
335 return r;
336
337 *ret = TAKE_PTR(res);
338 return 0;
339 }
340
341 static bool needs_glob(ItemType t) {
342 return IN_SET(t,
343 WRITE_FILE,
344 IGNORE_PATH,
345 IGNORE_DIRECTORY_PATH,
346 REMOVE_PATH,
347 RECURSIVE_REMOVE_PATH,
348 EMPTY_DIRECTORY,
349 ADJUST_MODE,
350 RELABEL_PATH,
351 RECURSIVE_RELABEL_PATH,
352 SET_XATTR,
353 RECURSIVE_SET_XATTR,
354 SET_ACL,
355 RECURSIVE_SET_ACL,
356 SET_ATTRIBUTE,
357 RECURSIVE_SET_ATTRIBUTE);
358 }
359
360 static bool takes_ownership(ItemType t) {
361 return IN_SET(t,
362 CREATE_FILE,
363 TRUNCATE_FILE,
364 CREATE_DIRECTORY,
365 EMPTY_DIRECTORY,
366 TRUNCATE_DIRECTORY,
367 CREATE_SUBVOLUME,
368 CREATE_SUBVOLUME_INHERIT_QUOTA,
369 CREATE_SUBVOLUME_NEW_QUOTA,
370 CREATE_FIFO,
371 CREATE_SYMLINK,
372 CREATE_CHAR_DEVICE,
373 CREATE_BLOCK_DEVICE,
374 COPY_FILES,
375 WRITE_FILE,
376 IGNORE_PATH,
377 IGNORE_DIRECTORY_PATH,
378 REMOVE_PATH,
379 RECURSIVE_REMOVE_PATH);
380 }
381
382 static struct Item* find_glob(OrderedHashmap *h, const char *match) {
383 ItemArray *j;
384
385 ORDERED_HASHMAP_FOREACH(j, h) {
386 size_t n;
387
388 for (n = 0; n < j->n_items; n++) {
389 Item *item = j->items + n;
390
391 if (fnmatch(item->path, match, FNM_PATHNAME|FNM_PERIOD) == 0)
392 return item;
393 }
394 }
395
396 return NULL;
397 }
398
399 static int load_unix_sockets(void) {
400 _cleanup_set_free_ Set *sockets = NULL;
401 _cleanup_fclose_ FILE *f = NULL;
402 int r;
403
404 if (unix_sockets)
405 return 0;
406
407 /* We maintain a cache of the sockets we found in /proc/net/unix to speed things up a little. */
408
409 f = fopen("/proc/net/unix", "re");
410 if (!f)
411 return log_full_errno(errno == ENOENT ? LOG_DEBUG : LOG_WARNING, errno,
412 "Failed to open /proc/net/unix, ignoring: %m");
413
414 /* Skip header */
415 r = read_line(f, LONG_LINE_MAX, NULL);
416 if (r < 0)
417 return log_warning_errno(r, "Failed to skip /proc/net/unix header line: %m");
418 if (r == 0)
419 return log_warning_errno(SYNTHETIC_ERRNO(EIO), "Premature end of file reading /proc/net/unix.");
420
421 for (;;) {
422 _cleanup_free_ char *line = NULL;
423 char *p;
424
425 r = read_line(f, LONG_LINE_MAX, &line);
426 if (r < 0)
427 return log_warning_errno(r, "Failed to read /proc/net/unix line, ignoring: %m");
428 if (r == 0) /* EOF */
429 break;
430
431 p = strchr(line, ':');
432 if (!p)
433 continue;
434
435 if (strlen(p) < 37)
436 continue;
437
438 p += 37;
439 p += strspn(p, WHITESPACE);
440 p += strcspn(p, WHITESPACE); /* skip one more word */
441 p += strspn(p, WHITESPACE);
442
443 if (!path_is_absolute(p))
444 continue;
445
446 r = set_put_strdup_full(&sockets, &path_hash_ops_free, p);
447 if (r < 0)
448 return log_warning_errno(r, "Failed to add AF_UNIX socket to set, ignoring: %m");
449 }
450
451 unix_sockets = TAKE_PTR(sockets);
452 return 1;
453 }
454
455 static bool unix_socket_alive(const char *fn) {
456 assert(fn);
457
458 if (load_unix_sockets() < 0)
459 return true; /* We don't know, so assume yes */
460
461 return set_contains(unix_sockets, fn);
462 }
463
464 static DIR* xopendirat_nomod(int dirfd, const char *path) {
465 DIR *dir;
466
467 dir = xopendirat(dirfd, path, O_NOFOLLOW|O_NOATIME);
468 if (dir)
469 return dir;
470
471 log_debug_errno(errno, "Cannot open %sdirectory \"%s\": %m", dirfd == AT_FDCWD ? "" : "sub", path);
472 if (errno != EPERM)
473 return NULL;
474
475 dir = xopendirat(dirfd, path, O_NOFOLLOW);
476 if (!dir)
477 log_debug_errno(errno, "Cannot open %sdirectory \"%s\": %m", dirfd == AT_FDCWD ? "" : "sub", path);
478
479 return dir;
480 }
481
482 static DIR* opendir_nomod(const char *path) {
483 return xopendirat_nomod(AT_FDCWD, path);
484 }
485
486 static inline nsec_t load_statx_timestamp_nsec(const struct statx_timestamp *ts) {
487 assert(ts);
488
489 if (ts->tv_sec < 0)
490 return NSEC_INFINITY;
491
492 if ((nsec_t) ts->tv_sec >= (UINT64_MAX - ts->tv_nsec) / NSEC_PER_SEC)
493 return NSEC_INFINITY;
494
495 return ts->tv_sec * NSEC_PER_SEC + ts->tv_nsec;
496 }
497
498 static bool needs_cleanup(
499 nsec_t atime,
500 nsec_t btime,
501 nsec_t ctime,
502 nsec_t mtime,
503 nsec_t cutoff,
504 const char *sub_path,
505 AgeBy age_by,
506 bool is_dir) {
507
508 if (FLAGS_SET(age_by, AGE_BY_MTIME) && mtime != NSEC_INFINITY && mtime >= cutoff) {
509 /* Follows spelling in stat(1). */
510 log_debug("%s \"%s\": modify time %s is too new.",
511 is_dir ? "Directory" : "File",
512 sub_path,
513 FORMAT_TIMESTAMP_STYLE(mtime / NSEC_PER_USEC, TIMESTAMP_US));
514
515 return false;
516 }
517
518 if (FLAGS_SET(age_by, AGE_BY_ATIME) && atime != NSEC_INFINITY && atime >= cutoff) {
519 log_debug("%s \"%s\": access time %s is too new.",
520 is_dir ? "Directory" : "File",
521 sub_path,
522 FORMAT_TIMESTAMP_STYLE(atime / NSEC_PER_USEC, TIMESTAMP_US));
523
524 return false;
525 }
526
527 /*
528 * Note: Unless explicitly specified by the user, "ctime" is ignored
529 * by default for directories, because we change it when deleting.
530 */
531 if (FLAGS_SET(age_by, AGE_BY_CTIME) && ctime != NSEC_INFINITY && ctime >= cutoff) {
532 log_debug("%s \"%s\": change time %s is too new.",
533 is_dir ? "Directory" : "File",
534 sub_path,
535 FORMAT_TIMESTAMP_STYLE(ctime / NSEC_PER_USEC, TIMESTAMP_US));
536
537 return false;
538 }
539
540 if (FLAGS_SET(age_by, AGE_BY_BTIME) && btime != NSEC_INFINITY && btime >= cutoff) {
541 log_debug("%s \"%s\": birth time %s is too new.",
542 is_dir ? "Directory" : "File",
543 sub_path,
544 FORMAT_TIMESTAMP_STYLE(btime / NSEC_PER_USEC, TIMESTAMP_US));
545
546 return false;
547 }
548
549 return true;
550 }
551
552 static int dir_cleanup(
553 Item *i,
554 const char *p,
555 DIR *d,
556 nsec_t self_atime_nsec,
557 nsec_t self_mtime_nsec,
558 nsec_t cutoff_nsec,
559 dev_t rootdev_major,
560 dev_t rootdev_minor,
561 bool mountpoint,
562 int maxdepth,
563 bool keep_this_level,
564 AgeBy age_by_file,
565 AgeBy age_by_dir) {
566
567 bool deleted = false;
568 int r = 0;
569
570 FOREACH_DIRENT_ALL(de, d, break) {
571 _cleanup_free_ char *sub_path = NULL;
572 nsec_t atime_nsec, mtime_nsec, ctime_nsec, btime_nsec;
573
574 if (dot_or_dot_dot(de->d_name))
575 continue;
576
577 /* If statx() is supported, use it. It's preferable over fstatat() since it tells us
578 * explicitly where we are looking at a mount point, for free as side information. Determining
579 * the same information without statx() is hard, see the complexity of path_is_mount_point(),
580 * and also much slower as it requires a number of syscalls instead of just one. Hence, when
581 * we have modern statx() we use it instead of fstat() and do proper mount point checks,
582 * while on older kernels's well do traditional st_dev based detection of mount points.
583 *
584 * Using statx() for detecting mount points also has the benfit that we handle weird file
585 * systems such as overlayfs better where each file is originating from a different
586 * st_dev. */
587
588 STRUCT_STATX_DEFINE(sx);
589
590 r = statx_fallback(
591 dirfd(d), de->d_name,
592 AT_SYMLINK_NOFOLLOW|AT_NO_AUTOMOUNT,
593 STATX_TYPE|STATX_MODE|STATX_UID|STATX_ATIME|STATX_MTIME|STATX_CTIME|STATX_BTIME,
594 &sx);
595 if (r == -ENOENT)
596 continue;
597 if (r < 0) {
598 /* FUSE, NFS mounts, SELinux might return EACCES */
599 r = log_full_errno(errno == EACCES ? LOG_DEBUG : LOG_ERR, errno,
600 "statx(%s/%s) failed: %m", p, de->d_name);
601 continue;
602 }
603
604 if (FLAGS_SET(sx.stx_attributes_mask, STATX_ATTR_MOUNT_ROOT)) {
605 /* Yay, we have the mount point API, use it */
606 if (FLAGS_SET(sx.stx_attributes, STATX_ATTR_MOUNT_ROOT)) {
607 log_debug("Ignoring \"%s/%s\": different mount points.", p, de->d_name);
608 continue;
609 }
610 } else {
611 /* So we might have statx() but the STATX_ATTR_MOUNT_ROOT flag is not supported, fall
612 * back to traditional stx_dev checking. */
613 if (sx.stx_dev_major != rootdev_major ||
614 sx.stx_dev_minor != rootdev_minor) {
615 log_debug("Ignoring \"%s/%s\": different filesystem.", p, de->d_name);
616 continue;
617 }
618
619 /* Try to detect bind mounts of the same filesystem instance; they do not differ in device
620 * major/minors. This type of query is not supported on all kernels or filesystem types
621 * though. */
622 if (S_ISDIR(sx.stx_mode)) {
623 int q;
624
625 q = fd_is_mount_point(dirfd(d), de->d_name, 0);
626 if (q < 0)
627 log_debug_errno(q, "Failed to determine whether \"%s/%s\" is a mount point, ignoring: %m", p, de->d_name);
628 else if (q > 0) {
629 log_debug("Ignoring \"%s/%s\": different mount of the same filesystem.", p, de->d_name);
630 continue;
631 }
632 }
633 }
634
635 atime_nsec = FLAGS_SET(sx.stx_mask, STATX_ATIME) ? load_statx_timestamp_nsec(&sx.stx_atime) : 0;
636 mtime_nsec = FLAGS_SET(sx.stx_mask, STATX_MTIME) ? load_statx_timestamp_nsec(&sx.stx_mtime) : 0;
637 ctime_nsec = FLAGS_SET(sx.stx_mask, STATX_CTIME) ? load_statx_timestamp_nsec(&sx.stx_ctime) : 0;
638 btime_nsec = FLAGS_SET(sx.stx_mask, STATX_BTIME) ? load_statx_timestamp_nsec(&sx.stx_btime) : 0;
639
640 sub_path = path_join(p, de->d_name);
641 if (!sub_path) {
642 r = log_oom();
643 goto finish;
644 }
645
646 /* Is there an item configured for this path? */
647 if (ordered_hashmap_get(items, sub_path)) {
648 log_debug("Ignoring \"%s\": a separate entry exists.", sub_path);
649 continue;
650 }
651
652 if (find_glob(globs, sub_path)) {
653 log_debug("Ignoring \"%s\": a separate glob exists.", sub_path);
654 continue;
655 }
656
657 if (S_ISDIR(sx.stx_mode)) {
658 _cleanup_closedir_ DIR *sub_dir = NULL;
659
660 if (mountpoint &&
661 streq(de->d_name, "lost+found") &&
662 sx.stx_uid == 0) {
663 log_debug("Ignoring directory \"%s\".", sub_path);
664 continue;
665 }
666
667 if (maxdepth <= 0)
668 log_warning("Reached max depth on \"%s\".", sub_path);
669 else {
670 int q;
671
672 sub_dir = xopendirat_nomod(dirfd(d), de->d_name);
673 if (!sub_dir) {
674 if (errno != ENOENT)
675 r = log_warning_errno(errno, "Opening directory \"%s\" failed, ignoring: %m", sub_path);
676
677 continue;
678 }
679
680 if (flock(dirfd(sub_dir), LOCK_EX|LOCK_NB) < 0) {
681 log_debug_errno(errno, "Couldn't acquire shared BSD lock on directory \"%s\", skipping: %m", p);
682 continue;
683 }
684
685 q = dir_cleanup(i,
686 sub_path, sub_dir,
687 atime_nsec, mtime_nsec, cutoff_nsec,
688 rootdev_major, rootdev_minor,
689 false, maxdepth-1, false,
690 age_by_file, age_by_dir);
691 if (q < 0)
692 r = q;
693 }
694
695 /* Note: if you are wondering why we don't support the sticky bit for excluding
696 * directories from cleaning like we do it for other file system objects: well, the
697 * sticky bit already has a meaning for directories, so we don't want to overload
698 * that. */
699
700 if (keep_this_level) {
701 log_debug("Keeping directory \"%s\".", sub_path);
702 continue;
703 }
704
705 /*
706 * Check the file timestamps of an entry against the
707 * given cutoff time; delete if it is older.
708 */
709 if (!needs_cleanup(atime_nsec, btime_nsec, ctime_nsec, mtime_nsec,
710 cutoff_nsec, sub_path, age_by_dir, true))
711 continue;
712
713 log_debug("Removing directory \"%s\".", sub_path);
714 if (unlinkat(dirfd(d), de->d_name, AT_REMOVEDIR) < 0)
715 if (!IN_SET(errno, ENOENT, ENOTEMPTY))
716 r = log_warning_errno(errno, "Failed to remove directory \"%s\", ignoring: %m", sub_path);
717
718 } else {
719 /* Skip files for which the sticky bit is set. These are semantics we define, and are
720 * unknown elsewhere. See XDG_RUNTIME_DIR specification for details. */
721 if (sx.stx_mode & S_ISVTX) {
722 log_debug("Skipping \"%s\": sticky bit set.", sub_path);
723 continue;
724 }
725
726 if (mountpoint &&
727 S_ISREG(sx.stx_mode) &&
728 sx.stx_uid == 0 &&
729 STR_IN_SET(de->d_name,
730 ".journal",
731 "aquota.user",
732 "aquota.group")) {
733 log_debug("Skipping \"%s\".", sub_path);
734 continue;
735 }
736
737 /* Ignore sockets that are listed in /proc/net/unix */
738 if (S_ISSOCK(sx.stx_mode) && unix_socket_alive(sub_path)) {
739 log_debug("Skipping \"%s\": live socket.", sub_path);
740 continue;
741 }
742
743 /* Ignore device nodes */
744 if (S_ISCHR(sx.stx_mode) || S_ISBLK(sx.stx_mode)) {
745 log_debug("Skipping \"%s\": a device.", sub_path);
746 continue;
747 }
748
749 /* Keep files on this level around if this is requested */
750 if (keep_this_level) {
751 log_debug("Keeping \"%s\".", sub_path);
752 continue;
753 }
754
755 if (!needs_cleanup(atime_nsec, btime_nsec, ctime_nsec, mtime_nsec,
756 cutoff_nsec, sub_path, age_by_file, false))
757 continue;
758
759 log_debug("Removing \"%s\".", sub_path);
760 if (unlinkat(dirfd(d), de->d_name, 0) < 0)
761 if (errno != ENOENT)
762 r = log_warning_errno(errno, "Failed to remove \"%s\", ignoring: %m", sub_path);
763
764 deleted = true;
765 }
766 }
767
768 finish:
769 if (deleted) {
770 struct timespec ts[2];
771
772 log_debug("Restoring access and modification time on \"%s\": %s, %s",
773 p,
774 FORMAT_TIMESTAMP_STYLE(self_atime_nsec / NSEC_PER_USEC, TIMESTAMP_US),
775 FORMAT_TIMESTAMP_STYLE(self_mtime_nsec / NSEC_PER_USEC, TIMESTAMP_US));
776
777 timespec_store_nsec(ts + 0, self_atime_nsec);
778 timespec_store_nsec(ts + 1, self_mtime_nsec);
779
780 /* Restore original directory timestamps */
781 if (futimens(dirfd(d), ts) < 0)
782 log_warning_errno(errno, "Failed to revert timestamps of '%s', ignoring: %m", p);
783 }
784
785 return r;
786 }
787
788 static bool dangerous_hardlinks(void) {
789 _cleanup_free_ char *value = NULL;
790 static int cached = -1;
791 int r;
792
793 /* Check whether the fs.protected_hardlinks sysctl is on. If we can't determine it we assume its off, as that's
794 * what the upstream default is. */
795
796 if (cached >= 0)
797 return cached;
798
799 r = read_one_line_file("/proc/sys/fs/protected_hardlinks", &value);
800 if (r < 0) {
801 log_debug_errno(r, "Failed to read fs.protected_hardlinks sysctl: %m");
802 return true;
803 }
804
805 r = parse_boolean(value);
806 if (r < 0) {
807 log_debug_errno(r, "Failed to parse fs.protected_hardlinks sysctl: %m");
808 return true;
809 }
810
811 cached = r == 0;
812 return cached;
813 }
814
815 static bool hardlink_vulnerable(const struct stat *st) {
816 assert(st);
817
818 return !S_ISDIR(st->st_mode) && st->st_nlink > 1 && dangerous_hardlinks();
819 }
820
821 static mode_t process_mask_perms(mode_t mode, mode_t current) {
822
823 if ((current & 0111) == 0)
824 mode &= ~0111;
825 if ((current & 0222) == 0)
826 mode &= ~0222;
827 if ((current & 0444) == 0)
828 mode &= ~0444;
829 if (!S_ISDIR(current))
830 mode &= ~07000; /* remove sticky/sgid/suid bit, unless directory */
831
832 return mode;
833 }
834
835 static int fd_set_perms(Item *i, int fd, const char *path, const struct stat *st) {
836 struct stat stbuf;
837 mode_t new_mode;
838 bool do_chown;
839 int r;
840
841 assert(i);
842 assert(fd >= 0);
843 assert(path);
844
845 if (!i->mode_set && !i->uid_set && !i->gid_set)
846 goto shortcut;
847
848 if (!st) {
849 if (fstat(fd, &stbuf) < 0)
850 return log_error_errno(errno, "fstat(%s) failed: %m", path);
851 st = &stbuf;
852 }
853
854 if (hardlink_vulnerable(st))
855 return log_error_errno(SYNTHETIC_ERRNO(EPERM),
856 "Refusing to set permissions on hardlinked file %s while the fs.protected_hardlinks sysctl is turned off.",
857 path);
858
859 /* Do we need a chown()? */
860 do_chown =
861 (i->uid_set && i->uid != st->st_uid) ||
862 (i->gid_set && i->gid != st->st_gid);
863
864 /* Calculate the mode to apply */
865 new_mode = i->mode_set ? (i->mask_perms ?
866 process_mask_perms(i->mode, st->st_mode) :
867 i->mode) :
868 (st->st_mode & 07777);
869
870 if (i->mode_set && do_chown) {
871 /* Before we issue the chmod() let's reduce the access mode to the common bits of the old and
872 * the new mode. That way there's no time window where the file exists under the old owner
873 * with more than the old access modes — and not under the new owner with more than the new
874 * access modes either. */
875
876 if (S_ISLNK(st->st_mode))
877 log_debug("Skipping temporary mode fix for symlink %s.", path);
878 else {
879 mode_t m = new_mode & st->st_mode; /* Mask new mode by old mode */
880
881 if (((m ^ st->st_mode) & 07777) == 0)
882 log_debug("\"%s\" matches temporary mode %o already.", path, m);
883 else {
884 log_debug("Temporarily changing \"%s\" to mode %o.", path, m);
885 r = fchmod_opath(fd, m);
886 if (r < 0)
887 return log_error_errno(r, "fchmod() of %s failed: %m", path);
888 }
889 }
890 }
891
892 if (do_chown) {
893 log_debug("Changing \"%s\" to owner "UID_FMT":"GID_FMT,
894 path,
895 i->uid_set ? i->uid : UID_INVALID,
896 i->gid_set ? i->gid : GID_INVALID);
897
898 if (fchownat(fd,
899 "",
900 i->uid_set ? i->uid : UID_INVALID,
901 i->gid_set ? i->gid : GID_INVALID,
902 AT_EMPTY_PATH) < 0)
903 return log_error_errno(errno, "fchownat() of %s failed: %m", path);
904 }
905
906 /* Now, apply the final mode. We do this in two cases: when the user set a mode explicitly, or after a
907 * chown(), since chown()'s mangle the access mode in regards to sgid/suid in some conditions. */
908 if (i->mode_set || do_chown) {
909 if (S_ISLNK(st->st_mode))
910 log_debug("Skipping mode fix for symlink %s.", path);
911 else {
912 /* Check if the chmod() is unnecessary. Note that if we did a chown() before we always
913 * chmod() here again, since it might have mangled the bits. */
914 if (!do_chown && ((new_mode ^ st->st_mode) & 07777) == 0)
915 log_debug("\"%s\" matches mode %o already.", path, new_mode);
916 else {
917 log_debug("Changing \"%s\" to mode %o.", path, new_mode);
918 r = fchmod_opath(fd, new_mode);
919 if (r < 0)
920 return log_error_errno(r, "fchmod() of %s failed: %m", path);
921 }
922 }
923 }
924
925 shortcut:
926 return label_fix(path, 0);
927 }
928
929 static int path_open_parent_safe(const char *path) {
930 _cleanup_free_ char *dn = NULL;
931 int r, fd;
932
933 if (path_equal(path, "/") || !path_is_normalized(path))
934 return log_error_errno(SYNTHETIC_ERRNO(EINVAL),
935 "Failed to open parent of '%s': invalid path.",
936 path);
937
938 dn = dirname_malloc(path);
939 if (!dn)
940 return log_oom();
941
942 r = chase_symlinks(dn, arg_root, CHASE_SAFE|CHASE_WARN, NULL, &fd);
943 if (r < 0 && r != -ENOLINK)
944 return log_error_errno(r, "Failed to validate path %s: %m", path);
945
946 return r < 0 ? r : fd;
947 }
948
949 static int path_open_safe(const char *path) {
950 int r, fd;
951
952 /* path_open_safe() returns a file descriptor opened with O_PATH after
953 * verifying that the path doesn't contain unsafe transitions, except
954 * for its final component as the function does not follow symlink. */
955
956 assert(path);
957
958 if (!path_is_normalized(path))
959 return log_error_errno(SYNTHETIC_ERRNO(EINVAL),
960 "Failed to open invalid path '%s'.",
961 path);
962
963 r = chase_symlinks(path, arg_root, CHASE_SAFE|CHASE_WARN|CHASE_NOFOLLOW, NULL, &fd);
964 if (r < 0 && r != -ENOLINK)
965 return log_error_errno(r, "Failed to validate path %s: %m", path);
966
967 return r < 0 ? r : fd;
968 }
969
970 static int path_set_perms(Item *i, const char *path) {
971 _cleanup_close_ int fd = -1;
972
973 assert(i);
974 assert(path);
975
976 fd = path_open_safe(path);
977 if (fd < 0)
978 return fd;
979
980 return fd_set_perms(i, fd, path, NULL);
981 }
982
983 static int parse_xattrs_from_arg(Item *i) {
984 const char *p;
985 int r;
986
987 assert(i);
988 assert(i->argument);
989
990 p = i->argument;
991
992 for (;;) {
993 _cleanup_free_ char *name = NULL, *value = NULL, *xattr = NULL;
994
995 r = extract_first_word(&p, &xattr, NULL, EXTRACT_UNQUOTE|EXTRACT_CUNESCAPE);
996 if (r < 0)
997 log_warning_errno(r, "Failed to parse extended attribute '%s', ignoring: %m", p);
998 if (r <= 0)
999 break;
1000
1001 r = split_pair(xattr, "=", &name, &value);
1002 if (r < 0) {
1003 log_warning_errno(r, "Failed to parse extended attribute, ignoring: %s", xattr);
1004 continue;
1005 }
1006
1007 if (isempty(name) || isempty(value)) {
1008 log_warning("Malformed extended attribute found, ignoring: %s", xattr);
1009 continue;
1010 }
1011
1012 if (strv_push_pair(&i->xattrs, name, value) < 0)
1013 return log_oom();
1014
1015 name = value = NULL;
1016 }
1017
1018 return 0;
1019 }
1020
1021 static int fd_set_xattrs(Item *i, int fd, const char *path, const struct stat *st) {
1022 assert(i);
1023 assert(fd >= 0);
1024 assert(path);
1025
1026 STRV_FOREACH_PAIR(name, value, i->xattrs) {
1027 log_debug("Setting extended attribute '%s=%s' on %s.", *name, *value, path);
1028 if (setxattr(FORMAT_PROC_FD_PATH(fd), *name, *value, strlen(*value), 0) < 0)
1029 return log_error_errno(errno, "Setting extended attribute %s=%s on %s failed: %m",
1030 *name, *value, path);
1031 }
1032 return 0;
1033 }
1034
1035 static int path_set_xattrs(Item *i, const char *path) {
1036 _cleanup_close_ int fd = -1;
1037
1038 assert(i);
1039 assert(path);
1040
1041 fd = path_open_safe(path);
1042 if (fd < 0)
1043 return fd;
1044
1045 return fd_set_xattrs(i, fd, path, NULL);
1046 }
1047
1048 static int parse_acls_from_arg(Item *item) {
1049 #if HAVE_ACL
1050 int r;
1051
1052 assert(item);
1053
1054 /* If append_or_force (= modify) is set, we will not modify the acl
1055 * afterwards, so the mask can be added now if necessary. */
1056
1057 r = parse_acl(item->argument, &item->acl_access, &item->acl_default, !item->append_or_force);
1058 if (r < 0)
1059 log_warning_errno(r, "Failed to parse ACL \"%s\": %m. Ignoring", item->argument);
1060 #else
1061 log_warning("ACLs are not supported. Ignoring.");
1062 #endif
1063
1064 return 0;
1065 }
1066
1067 #if HAVE_ACL
1068 static int path_set_acl(const char *path, const char *pretty, acl_type_t type, acl_t acl, bool modify) {
1069 _cleanup_(acl_free_charpp) char *t = NULL;
1070 _cleanup_(acl_freep) acl_t dup = NULL;
1071 int r;
1072
1073 /* Returns 0 for success, positive error if already warned,
1074 * negative error otherwise. */
1075
1076 if (modify) {
1077 r = acls_for_file(path, type, acl, &dup);
1078 if (r < 0)
1079 return r;
1080
1081 r = calc_acl_mask_if_needed(&dup);
1082 if (r < 0)
1083 return r;
1084 } else {
1085 dup = acl_dup(acl);
1086 if (!dup)
1087 return -errno;
1088
1089 /* the mask was already added earlier if needed */
1090 }
1091
1092 r = add_base_acls_if_needed(&dup, path);
1093 if (r < 0)
1094 return r;
1095
1096 t = acl_to_any_text(dup, NULL, ',', TEXT_ABBREVIATE);
1097 log_debug("Setting %s ACL %s on %s.",
1098 type == ACL_TYPE_ACCESS ? "access" : "default",
1099 strna(t), pretty);
1100
1101 r = acl_set_file(path, type, dup);
1102 if (r < 0) {
1103 if (ERRNO_IS_NOT_SUPPORTED(errno))
1104 /* No error if filesystem doesn't support ACLs. Return negative. */
1105 return -errno;
1106 else
1107 /* Return positive to indicate we already warned */
1108 return -log_error_errno(errno,
1109 "Setting %s ACL \"%s\" on %s failed: %m",
1110 type == ACL_TYPE_ACCESS ? "access" : "default",
1111 strna(t), pretty);
1112 }
1113 return 0;
1114 }
1115 #endif
1116
1117 static int fd_set_acls(Item *item, int fd, const char *path, const struct stat *st) {
1118 int r = 0;
1119 #if HAVE_ACL
1120 struct stat stbuf;
1121
1122 assert(item);
1123 assert(fd >= 0);
1124 assert(path);
1125
1126 if (!st) {
1127 if (fstat(fd, &stbuf) < 0)
1128 return log_error_errno(errno, "fstat(%s) failed: %m", path);
1129 st = &stbuf;
1130 }
1131
1132 if (hardlink_vulnerable(st))
1133 return log_error_errno(SYNTHETIC_ERRNO(EPERM),
1134 "Refusing to set ACLs on hardlinked file %s while the fs.protected_hardlinks sysctl is turned off.",
1135 path);
1136
1137 if (S_ISLNK(st->st_mode)) {
1138 log_debug("Skipping ACL fix for symlink %s.", path);
1139 return 0;
1140 }
1141
1142 if (item->acl_access)
1143 r = path_set_acl(FORMAT_PROC_FD_PATH(fd), path, ACL_TYPE_ACCESS, item->acl_access, item->append_or_force);
1144
1145 /* set only default acls to folders */
1146 if (r == 0 && item->acl_default && S_ISDIR(st->st_mode))
1147 r = path_set_acl(FORMAT_PROC_FD_PATH(fd), path, ACL_TYPE_DEFAULT, item->acl_default, item->append_or_force);
1148
1149 if (ERRNO_IS_NOT_SUPPORTED(r)) {
1150 log_debug_errno(r, "ACLs not supported by file system at %s", path);
1151 return 0;
1152 }
1153
1154 if (r > 0)
1155 return -r; /* already warned */
1156
1157 /* The above procfs paths don't work if /proc is not mounted. */
1158 if (r == -ENOENT && proc_mounted() == 0)
1159 r = -ENOSYS;
1160
1161 if (r < 0)
1162 return log_error_errno(r, "ACL operation on \"%s\" failed: %m", path);
1163 #endif
1164 return r;
1165 }
1166
1167 static int path_set_acls(Item *item, const char *path) {
1168 int r = 0;
1169 #if HAVE_ACL
1170 _cleanup_close_ int fd = -1;
1171
1172 assert(item);
1173 assert(path);
1174
1175 fd = path_open_safe(path);
1176 if (fd < 0)
1177 return fd;
1178
1179 r = fd_set_acls(item, fd, path, NULL);
1180 #endif
1181 return r;
1182 }
1183
1184 static int parse_attribute_from_arg(Item *item) {
1185
1186 static const struct {
1187 char character;
1188 unsigned value;
1189 } attributes[] = {
1190 { 'A', FS_NOATIME_FL }, /* do not update atime */
1191 { 'S', FS_SYNC_FL }, /* Synchronous updates */
1192 { 'D', FS_DIRSYNC_FL }, /* dirsync behaviour (directories only) */
1193 { 'a', FS_APPEND_FL }, /* writes to file may only append */
1194 { 'c', FS_COMPR_FL }, /* Compress file */
1195 { 'd', FS_NODUMP_FL }, /* do not dump file */
1196 { 'e', FS_EXTENT_FL }, /* Extents */
1197 { 'i', FS_IMMUTABLE_FL }, /* Immutable file */
1198 { 'j', FS_JOURNAL_DATA_FL }, /* Reserved for ext3 */
1199 { 's', FS_SECRM_FL }, /* Secure deletion */
1200 { 'u', FS_UNRM_FL }, /* Undelete */
1201 { 't', FS_NOTAIL_FL }, /* file tail should not be merged */
1202 { 'T', FS_TOPDIR_FL }, /* Top of directory hierarchies */
1203 { 'C', FS_NOCOW_FL }, /* Do not cow file */
1204 { 'P', FS_PROJINHERIT_FL }, /* Inherit the quota project ID */
1205 };
1206
1207 enum {
1208 MODE_ADD,
1209 MODE_DEL,
1210 MODE_SET
1211 } mode = MODE_ADD;
1212
1213 unsigned value = 0, mask = 0;
1214 const char *p;
1215
1216 assert(item);
1217
1218 p = item->argument;
1219 if (p) {
1220 if (*p == '+') {
1221 mode = MODE_ADD;
1222 p++;
1223 } else if (*p == '-') {
1224 mode = MODE_DEL;
1225 p++;
1226 } else if (*p == '=') {
1227 mode = MODE_SET;
1228 p++;
1229 }
1230 }
1231
1232 if (isempty(p) && mode != MODE_SET)
1233 return log_error_errno(SYNTHETIC_ERRNO(EINVAL),
1234 "Setting file attribute on '%s' needs an attribute specification.",
1235 item->path);
1236
1237 for (; p && *p ; p++) {
1238 unsigned i, v;
1239
1240 for (i = 0; i < ELEMENTSOF(attributes); i++)
1241 if (*p == attributes[i].character)
1242 break;
1243
1244 if (i >= ELEMENTSOF(attributes))
1245 return log_error_errno(SYNTHETIC_ERRNO(EINVAL),
1246 "Unknown file attribute '%c' on '%s'.",
1247 *p, item->path);
1248
1249 v = attributes[i].value;
1250
1251 SET_FLAG(value, v, IN_SET(mode, MODE_ADD, MODE_SET));
1252
1253 mask |= v;
1254 }
1255
1256 if (mode == MODE_SET)
1257 mask |= CHATTR_ALL_FL;
1258
1259 assert(mask != 0);
1260
1261 item->attribute_mask = mask;
1262 item->attribute_value = value;
1263 item->attribute_set = true;
1264
1265 return 0;
1266 }
1267
1268 static int fd_set_attribute(Item *item, int fd, const char *path, const struct stat *st) {
1269 _cleanup_close_ int procfs_fd = -1;
1270 struct stat stbuf;
1271 unsigned f;
1272 int r;
1273
1274 assert(item);
1275 assert(fd >= 0);
1276 assert(path);
1277
1278 if (!item->attribute_set || item->attribute_mask == 0)
1279 return 0;
1280
1281 if (!st) {
1282 if (fstat(fd, &stbuf) < 0)
1283 return log_error_errno(errno, "fstat(%s) failed: %m", path);
1284 st = &stbuf;
1285 }
1286
1287 /* Issuing the file attribute ioctls on device nodes is not
1288 * safe, as that will be delivered to the drivers, not the
1289 * file system containing the device node. */
1290 if (!S_ISREG(st->st_mode) && !S_ISDIR(st->st_mode))
1291 return log_error_errno(SYNTHETIC_ERRNO(EINVAL),
1292 "Setting file flags is only supported on regular files and directories, cannot set on '%s'.",
1293 path);
1294
1295 f = item->attribute_value & item->attribute_mask;
1296
1297 /* Mask away directory-specific flags */
1298 if (!S_ISDIR(st->st_mode))
1299 f &= ~FS_DIRSYNC_FL;
1300
1301 procfs_fd = fd_reopen(fd, O_RDONLY|O_CLOEXEC|O_NOATIME);
1302 if (procfs_fd < 0)
1303 return log_error_errno(procfs_fd, "Failed to re-open '%s': %m", path);
1304
1305 unsigned previous, current;
1306 r = chattr_full(NULL, procfs_fd, f, item->attribute_mask, &previous, &current, CHATTR_FALLBACK_BITWISE);
1307 if (r == -ENOANO)
1308 log_warning("Cannot set file attributes for '%s', maybe due to incompatibility in specified attributes, "
1309 "previous=0x%08x, current=0x%08x, expected=0x%08x, ignoring.",
1310 path, previous, current, (previous & ~item->attribute_mask) | (f & item->attribute_mask));
1311 else if (r < 0)
1312 log_full_errno(ERRNO_IS_NOT_SUPPORTED(r) ? LOG_DEBUG : LOG_WARNING, r,
1313 "Cannot set file attributes for '%s', value=0x%08x, mask=0x%08x, ignoring: %m",
1314 path, item->attribute_value, item->attribute_mask);
1315
1316 return 0;
1317 }
1318
1319 static int path_set_attribute(Item *item, const char *path) {
1320 _cleanup_close_ int fd = -1;
1321
1322 if (!item->attribute_set || item->attribute_mask == 0)
1323 return 0;
1324
1325 fd = path_open_safe(path);
1326 if (fd < 0)
1327 return fd;
1328
1329 return fd_set_attribute(item, fd, path, NULL);
1330 }
1331
1332 static int write_one_file(Item *i, const char *path) {
1333 _cleanup_close_ int fd = -1, dir_fd = -1;
1334 char *bn;
1335 int r;
1336
1337 assert(i);
1338 assert(path);
1339 assert(i->argument);
1340 assert(i->type == WRITE_FILE);
1341
1342 /* Validate the path and keep the fd on the directory for opening the
1343 * file so we're sure that it can't be changed behind our back. */
1344 dir_fd = path_open_parent_safe(path);
1345 if (dir_fd < 0)
1346 return dir_fd;
1347
1348 bn = basename(path);
1349
1350 /* Follows symlinks */
1351 fd = openat(dir_fd, bn,
1352 O_NONBLOCK|O_CLOEXEC|O_WRONLY|O_NOCTTY|(i->append_or_force ? O_APPEND : 0),
1353 i->mode);
1354 if (fd < 0) {
1355 if (errno == ENOENT) {
1356 log_debug_errno(errno, "Not writing missing file \"%s\": %m", path);
1357 return 0;
1358 }
1359
1360 if (i->allow_failure)
1361 return log_debug_errno(errno, "Failed to open file \"%s\", ignoring: %m", path);
1362
1363 return log_error_errno(errno, "Failed to open file \"%s\": %m", path);
1364 }
1365
1366 /* 'w' is allowed to write into any kind of files. */
1367 log_debug("Writing to \"%s\".", path);
1368
1369 r = loop_write(fd, i->argument, strlen(i->argument), false);
1370 if (r < 0)
1371 return log_error_errno(r, "Failed to write file \"%s\": %m", path);
1372
1373 return fd_set_perms(i, fd, path, NULL);
1374 }
1375
1376 static int create_file(Item *i, const char *path) {
1377 _cleanup_close_ int fd = -1, dir_fd = -1;
1378 struct stat stbuf, *st = NULL;
1379 int r = 0;
1380 char *bn;
1381
1382 assert(i);
1383 assert(path);
1384 assert(i->type == CREATE_FILE);
1385
1386 /* 'f' operates on regular files exclusively. */
1387
1388 /* Validate the path and keep the fd on the directory for opening the
1389 * file so we're sure that it can't be changed behind our back. */
1390 dir_fd = path_open_parent_safe(path);
1391 if (dir_fd < 0)
1392 return dir_fd;
1393
1394 bn = basename(path);
1395
1396 RUN_WITH_UMASK(0000) {
1397 mac_selinux_create_file_prepare(path, S_IFREG);
1398 fd = openat(dir_fd, bn, O_CREAT|O_EXCL|O_NOFOLLOW|O_NONBLOCK|O_CLOEXEC|O_WRONLY|O_NOCTTY, i->mode);
1399 mac_selinux_create_file_clear();
1400 }
1401
1402 if (fd < 0) {
1403 /* Even on a read-only filesystem, open(2) returns EEXIST if the
1404 * file already exists. It returns EROFS only if it needs to
1405 * create the file. */
1406 if (errno != EEXIST)
1407 return log_error_errno(errno, "Failed to create file %s: %m", path);
1408
1409 /* Re-open the file. At that point it must exist since open(2)
1410 * failed with EEXIST. We still need to check if the perms/mode
1411 * need to be changed. For read-only filesystems, we let
1412 * fd_set_perms() report the error if the perms need to be
1413 * modified. */
1414 fd = openat(dir_fd, bn, O_NOFOLLOW|O_CLOEXEC|O_PATH, i->mode);
1415 if (fd < 0)
1416 return log_error_errno(errno, "Failed to re-open file %s: %m", path);
1417
1418 if (fstat(fd, &stbuf) < 0)
1419 return log_error_errno(errno, "stat(%s) failed: %m", path);
1420
1421 if (!S_ISREG(stbuf.st_mode))
1422 return log_error_errno(SYNTHETIC_ERRNO(EEXIST),
1423 "%s exists and is not a regular file.",
1424 path);
1425
1426 st = &stbuf;
1427 } else {
1428
1429 log_debug("\"%s\" has been created.", path);
1430
1431 if (i->argument) {
1432 log_debug("Writing to \"%s\".", path);
1433
1434 r = loop_write(fd, i->argument, strlen(i->argument), false);
1435 if (r < 0)
1436 return log_error_errno(r, "Failed to write file \"%s\": %m", path);
1437 }
1438 }
1439
1440 return fd_set_perms(i, fd, path, st);
1441 }
1442
1443 static int truncate_file(Item *i, const char *path) {
1444 _cleanup_close_ int fd = -1, dir_fd = -1;
1445 struct stat stbuf, *st = NULL;
1446 bool erofs = false;
1447 int r = 0;
1448 char *bn;
1449
1450 assert(i);
1451 assert(path);
1452 assert(i->type == TRUNCATE_FILE || (i->type == CREATE_FILE && i->append_or_force));
1453
1454 /* We want to operate on regular file exclusively especially since
1455 * O_TRUNC is unspecified if the file is neither a regular file nor a
1456 * fifo nor a terminal device. Therefore we first open the file and make
1457 * sure it's a regular one before truncating it. */
1458
1459 /* Validate the path and keep the fd on the directory for opening the
1460 * file so we're sure that it can't be changed behind our back. */
1461 dir_fd = path_open_parent_safe(path);
1462 if (dir_fd < 0)
1463 return dir_fd;
1464
1465 bn = basename(path);
1466
1467 RUN_WITH_UMASK(0000) {
1468 mac_selinux_create_file_prepare(path, S_IFREG);
1469 fd = openat(dir_fd, bn, O_CREAT|O_NOFOLLOW|O_NONBLOCK|O_CLOEXEC|O_WRONLY|O_NOCTTY, i->mode);
1470 mac_selinux_create_file_clear();
1471 }
1472
1473 if (fd < 0) {
1474 if (errno != EROFS)
1475 return log_error_errno(errno, "Failed to open/create file %s: %m", path);
1476
1477 /* On a read-only filesystem, we don't want to fail if the
1478 * target is already empty and the perms are set. So we still
1479 * proceed with the sanity checks and let the remaining
1480 * operations fail with EROFS if they try to modify the target
1481 * file. */
1482
1483 fd = openat(dir_fd, bn, O_NOFOLLOW|O_CLOEXEC|O_PATH, i->mode);
1484 if (fd < 0) {
1485 if (errno == ENOENT)
1486 return log_error_errno(SYNTHETIC_ERRNO(EROFS),
1487 "Cannot create file %s on a read-only file system.",
1488 path);
1489
1490 return log_error_errno(errno, "Failed to re-open file %s: %m", path);
1491 }
1492
1493 erofs = true;
1494 }
1495
1496 if (fstat(fd, &stbuf) < 0)
1497 return log_error_errno(errno, "stat(%s) failed: %m", path);
1498
1499 if (!S_ISREG(stbuf.st_mode))
1500 return log_error_errno(SYNTHETIC_ERRNO(EEXIST),
1501 "%s exists and is not a regular file.",
1502 path);
1503
1504 if (stbuf.st_size > 0) {
1505 if (ftruncate(fd, 0) < 0) {
1506 r = erofs ? -EROFS : -errno;
1507 return log_error_errno(r, "Failed to truncate file %s: %m", path);
1508 }
1509 } else
1510 st = &stbuf;
1511
1512 log_debug("\"%s\" has been created.", path);
1513
1514 if (i->argument) {
1515 log_debug("Writing to \"%s\".", path);
1516
1517 r = loop_write(fd, i->argument, strlen(i->argument), false);
1518 if (r < 0) {
1519 r = erofs ? -EROFS : r;
1520 return log_error_errno(r, "Failed to write file %s: %m", path);
1521 }
1522 }
1523
1524 return fd_set_perms(i, fd, path, st);
1525 }
1526
1527 static int copy_files(Item *i) {
1528 _cleanup_close_ int dfd = -1, fd = -1;
1529 char *bn;
1530 int r;
1531
1532 log_debug("Copying tree \"%s\" to \"%s\".", i->argument, i->path);
1533
1534 bn = basename(i->path);
1535
1536 /* Validate the path and use the returned directory fd for copying the
1537 * target so we're sure that the path can't be changed behind our
1538 * back. */
1539 dfd = path_open_parent_safe(i->path);
1540 if (dfd < 0)
1541 return dfd;
1542
1543 r = copy_tree_at(AT_FDCWD, i->argument,
1544 dfd, bn,
1545 i->uid_set ? i->uid : UID_INVALID,
1546 i->gid_set ? i->gid : GID_INVALID,
1547 COPY_REFLINK | COPY_MERGE_EMPTY | COPY_MAC_CREATE | COPY_HARDLINKS);
1548 if (r < 0) {
1549 struct stat a, b;
1550
1551 /* If the target already exists on read-only filesystems, trying
1552 * to create the target will not fail with EEXIST but with
1553 * EROFS. */
1554 if (r == -EROFS && faccessat(dfd, bn, F_OK, AT_SYMLINK_NOFOLLOW) == 0)
1555 r = -EEXIST;
1556
1557 if (r != -EEXIST)
1558 return log_error_errno(r, "Failed to copy files to %s: %m", i->path);
1559
1560 if (stat(i->argument, &a) < 0)
1561 return log_error_errno(errno, "stat(%s) failed: %m", i->argument);
1562
1563 if (fstatat(dfd, bn, &b, AT_SYMLINK_NOFOLLOW) < 0)
1564 return log_error_errno(errno, "stat(%s) failed: %m", i->path);
1565
1566 if ((a.st_mode ^ b.st_mode) & S_IFMT) {
1567 log_debug("Can't copy to %s, file exists already and is of different type", i->path);
1568 return 0;
1569 }
1570 }
1571
1572 fd = openat(dfd, bn, O_NOFOLLOW|O_CLOEXEC|O_PATH);
1573 if (fd < 0)
1574 return log_error_errno(errno, "Failed to openat(%s): %m", i->path);
1575
1576 return fd_set_perms(i, fd, i->path, NULL);
1577 }
1578
1579 typedef enum {
1580 CREATION_NORMAL,
1581 CREATION_EXISTING,
1582 CREATION_FORCE,
1583 _CREATION_MODE_MAX,
1584 _CREATION_MODE_INVALID = -EINVAL,
1585 } CreationMode;
1586
1587 static const char *const creation_mode_verb_table[_CREATION_MODE_MAX] = {
1588 [CREATION_NORMAL] = "Created",
1589 [CREATION_EXISTING] = "Found existing",
1590 [CREATION_FORCE] = "Created replacement",
1591 };
1592
1593 DEFINE_PRIVATE_STRING_TABLE_LOOKUP_TO_STRING(creation_mode_verb, CreationMode);
1594
1595 static int create_directory_or_subvolume(const char *path, mode_t mode, bool subvol, CreationMode *creation) {
1596 _cleanup_close_ int pfd = -1;
1597 CreationMode c;
1598 int r;
1599
1600 assert(path);
1601
1602 if (!creation)
1603 creation = &c;
1604
1605 pfd = path_open_parent_safe(path);
1606 if (pfd < 0)
1607 return pfd;
1608
1609 if (subvol) {
1610 r = getenv_bool("SYSTEMD_TMPFILES_FORCE_SUBVOL");
1611 if (r < 0) {
1612 if (r != -ENXIO) /* env var is unset */
1613 log_warning_errno(r, "Cannot parse value of $SYSTEMD_TMPFILES_FORCE_SUBVOL, ignoring.");
1614 r = btrfs_is_subvol(empty_to_root(arg_root)) > 0;
1615 }
1616 if (!r)
1617 /* Don't create a subvolume unless the root directory is
1618 * one, too. We do this under the assumption that if the
1619 * root directory is just a plain directory (i.e. very
1620 * light-weight), we shouldn't try to split it up into
1621 * subvolumes (i.e. more heavy-weight). Thus, chroot()
1622 * environments and suchlike will get a full brtfs
1623 * subvolume set up below their tree only if they
1624 * specifically set up a btrfs subvolume for the root
1625 * dir too. */
1626
1627 subvol = false;
1628 else {
1629 RUN_WITH_UMASK((~mode) & 0777)
1630 r = btrfs_subvol_make_fd(pfd, basename(path));
1631 }
1632 } else
1633 r = 0;
1634
1635 if (!subvol || r == -ENOTTY)
1636 RUN_WITH_UMASK(0000)
1637 r = mkdirat_label(pfd, basename(path), mode);
1638
1639 if (r < 0) {
1640 int k;
1641
1642 if (!IN_SET(r, -EEXIST, -EROFS))
1643 return log_error_errno(r, "Failed to create directory or subvolume \"%s\": %m", path);
1644
1645 k = is_dir_fd(pfd);
1646 if (k == -ENOENT && r == -EROFS)
1647 return log_error_errno(r, "%s does not exist and cannot be created as the file system is read-only.", path);
1648 if (k < 0)
1649 return log_error_errno(k, "Failed to check if %s exists: %m", path);
1650 if (!k)
1651 return log_warning_errno(SYNTHETIC_ERRNO(EEXIST),
1652 "\"%s\" already exists and is not a directory.", path);
1653
1654 *creation = CREATION_EXISTING;
1655 } else
1656 *creation = CREATION_NORMAL;
1657
1658 log_debug("%s directory \"%s\".", creation_mode_verb_to_string(*creation), path);
1659
1660 r = openat(pfd, basename(path), O_NOCTTY|O_CLOEXEC|O_DIRECTORY);
1661 if (r < 0)
1662 return log_error_errno(errno, "Failed to open directory '%s': %m", basename(path));
1663
1664 return r;
1665 }
1666
1667 static int create_directory(Item *i, const char *path) {
1668 _cleanup_close_ int fd = -1;
1669
1670 assert(i);
1671 assert(IN_SET(i->type, CREATE_DIRECTORY, TRUNCATE_DIRECTORY));
1672
1673 fd = create_directory_or_subvolume(path, i->mode, false, NULL);
1674 if (fd == -EEXIST)
1675 return 0;
1676 if (fd < 0)
1677 return fd;
1678
1679 return fd_set_perms(i, fd, path, NULL);
1680 }
1681
1682 static int create_subvolume(Item *i, const char *path) {
1683 _cleanup_close_ int fd = -1;
1684 CreationMode creation;
1685 int r, q = 0;
1686
1687 assert(i);
1688 assert(IN_SET(i->type, CREATE_SUBVOLUME, CREATE_SUBVOLUME_NEW_QUOTA, CREATE_SUBVOLUME_INHERIT_QUOTA));
1689
1690 fd = create_directory_or_subvolume(path, i->mode, true, &creation);
1691 if (fd == -EEXIST)
1692 return 0;
1693 if (fd < 0)
1694 return fd;
1695
1696 if (creation == CREATION_NORMAL &&
1697 IN_SET(i->type, CREATE_SUBVOLUME_NEW_QUOTA, CREATE_SUBVOLUME_INHERIT_QUOTA)) {
1698 r = btrfs_subvol_auto_qgroup_fd(fd, 0, i->type == CREATE_SUBVOLUME_NEW_QUOTA);
1699 if (r == -ENOTTY)
1700 log_debug_errno(r, "Couldn't adjust quota for subvolume \"%s\" (unsupported fs or dir not a subvolume): %m", i->path);
1701 else if (r == -EROFS)
1702 log_debug_errno(r, "Couldn't adjust quota for subvolume \"%s\" (fs is read-only).", i->path);
1703 else if (r == -ENOTCONN)
1704 log_debug_errno(r, "Couldn't adjust quota for subvolume \"%s\" (quota support is disabled).", i->path);
1705 else if (r < 0)
1706 q = log_error_errno(r, "Failed to adjust quota for subvolume \"%s\": %m", i->path);
1707 else if (r > 0)
1708 log_debug("Adjusted quota for subvolume \"%s\".", i->path);
1709 else if (r == 0)
1710 log_debug("Quota for subvolume \"%s\" already in place, no change made.", i->path);
1711 }
1712
1713 r = fd_set_perms(i, fd, path, NULL);
1714 if (q < 0) /* prefer the quota change error from above */
1715 return q;
1716
1717 return r;
1718 }
1719
1720 static int empty_directory(Item *i, const char *path) {
1721 int r;
1722
1723 assert(i);
1724 assert(i->type == EMPTY_DIRECTORY);
1725
1726 r = is_dir(path, false);
1727 if (r == -ENOENT) {
1728 /* Option "e" operates only on existing objects. Do not
1729 * print errors about non-existent files or directories */
1730 log_debug("Skipping missing directory: %s", path);
1731 return 0;
1732 }
1733 if (r < 0)
1734 return log_error_errno(r, "is_dir() failed on path %s: %m", path);
1735 if (r == 0) {
1736 log_warning("\"%s\" already exists and is not a directory.", path);
1737 return 0;
1738 }
1739
1740 return path_set_perms(i, path);
1741 }
1742
1743 static int create_device(Item *i, mode_t file_type) {
1744 _cleanup_close_ int dfd = -1, fd = -1;
1745 CreationMode creation;
1746 char *bn;
1747 int r;
1748
1749 assert(i);
1750 assert(IN_SET(file_type, S_IFBLK, S_IFCHR));
1751
1752 bn = basename(i->path);
1753
1754 /* Validate the path and use the returned directory fd for copying the
1755 * target so we're sure that the path can't be changed behind our
1756 * back. */
1757 dfd = path_open_parent_safe(i->path);
1758 if (dfd < 0)
1759 return dfd;
1760
1761 RUN_WITH_UMASK(0000) {
1762 mac_selinux_create_file_prepare(i->path, file_type);
1763 r = mknodat(dfd, bn, i->mode | file_type, i->major_minor);
1764 mac_selinux_create_file_clear();
1765 }
1766
1767 if (r < 0) {
1768 struct stat st;
1769
1770 if (errno == EPERM) {
1771 log_debug("We lack permissions, possibly because of cgroup configuration; "
1772 "skipping creation of device node %s.", i->path);
1773 return 0;
1774 }
1775
1776 if (errno != EEXIST)
1777 return log_error_errno(errno, "Failed to create device node %s: %m", i->path);
1778
1779 if (fstatat(dfd, bn, &st, 0) < 0)
1780 return log_error_errno(errno, "stat(%s) failed: %m", i->path);
1781
1782 if ((st.st_mode & S_IFMT) != file_type) {
1783
1784 if (i->append_or_force) {
1785
1786 RUN_WITH_UMASK(0000) {
1787 mac_selinux_create_file_prepare(i->path, file_type);
1788 /* FIXME: need to introduce mknodat_atomic() */
1789 r = mknod_atomic(i->path, i->mode | file_type, i->major_minor);
1790 mac_selinux_create_file_clear();
1791 }
1792
1793 if (r < 0)
1794 return log_error_errno(r, "Failed to create device node \"%s\": %m", i->path);
1795 creation = CREATION_FORCE;
1796 } else {
1797 log_warning("\"%s\" already exists is not a device node.", i->path);
1798 return 0;
1799 }
1800 } else
1801 creation = CREATION_EXISTING;
1802 } else
1803 creation = CREATION_NORMAL;
1804
1805 log_debug("%s %s device node \"%s\" %u:%u.",
1806 creation_mode_verb_to_string(creation),
1807 i->type == CREATE_BLOCK_DEVICE ? "block" : "char",
1808 i->path, major(i->mode), minor(i->mode));
1809
1810 fd = openat(dfd, bn, O_NOFOLLOW|O_CLOEXEC|O_PATH);
1811 if (fd < 0)
1812 return log_error_errno(errno, "Failed to openat(%s): %m", i->path);
1813
1814 return fd_set_perms(i, fd, i->path, NULL);
1815 }
1816
1817 static int create_fifo(Item *i, const char *path) {
1818 _cleanup_close_ int pfd = -1, fd = -1;
1819 CreationMode creation;
1820 struct stat st;
1821 char *bn;
1822 int r;
1823
1824 pfd = path_open_parent_safe(path);
1825 if (pfd < 0)
1826 return pfd;
1827
1828 bn = basename(path);
1829
1830 RUN_WITH_UMASK(0000) {
1831 mac_selinux_create_file_prepare(path, S_IFIFO);
1832 r = mkfifoat(pfd, bn, i->mode);
1833 mac_selinux_create_file_clear();
1834 }
1835
1836 if (r < 0) {
1837 if (errno != EEXIST)
1838 return log_error_errno(errno, "Failed to create fifo %s: %m", path);
1839
1840 if (fstatat(pfd, bn, &st, AT_SYMLINK_NOFOLLOW) < 0)
1841 return log_error_errno(errno, "stat(%s) failed: %m", path);
1842
1843 if (!S_ISFIFO(st.st_mode)) {
1844
1845 if (i->append_or_force) {
1846 RUN_WITH_UMASK(0000) {
1847 mac_selinux_create_file_prepare(path, S_IFIFO);
1848 r = mkfifoat_atomic(pfd, bn, i->mode);
1849 mac_selinux_create_file_clear();
1850 }
1851
1852 if (r < 0)
1853 return log_error_errno(r, "Failed to create fifo %s: %m", path);
1854 creation = CREATION_FORCE;
1855 } else {
1856 log_warning("\"%s\" already exists and is not a fifo.", path);
1857 return 0;
1858 }
1859 } else
1860 creation = CREATION_EXISTING;
1861 } else
1862 creation = CREATION_NORMAL;
1863
1864 log_debug("%s fifo \"%s\".", creation_mode_verb_to_string(creation), path);
1865
1866 fd = openat(pfd, bn, O_NOFOLLOW|O_CLOEXEC|O_PATH);
1867 if (fd < 0)
1868 return log_error_errno(errno, "Failed to openat(%s): %m", path);
1869
1870 return fd_set_perms(i, fd, i->path, NULL);
1871 }
1872
1873 typedef int (*action_t)(Item *i, const char *path);
1874 typedef int (*fdaction_t)(Item *i, int fd, const char *path, const struct stat *st);
1875
1876 static int item_do(Item *i, int fd, const char *path, fdaction_t action) {
1877 struct stat st;
1878 int r = 0, q;
1879
1880 assert(i);
1881 assert(path);
1882 assert(fd >= 0);
1883
1884 if (fstat(fd, &st) < 0) {
1885 r = log_error_errno(errno, "fstat() on file failed: %m");
1886 goto finish;
1887 }
1888
1889 /* This returns the first error we run into, but nevertheless
1890 * tries to go on */
1891 r = action(i, fd, path, &st);
1892
1893 if (S_ISDIR(st.st_mode)) {
1894 _cleanup_closedir_ DIR *d = NULL;
1895
1896 /* The passed 'fd' was opened with O_PATH. We need to convert it into a 'regular' fd before
1897 * reading the directory content. */
1898 d = opendir(FORMAT_PROC_FD_PATH(fd));
1899 if (!d) {
1900 log_error_errno(errno, "Failed to opendir() '%s': %m", FORMAT_PROC_FD_PATH(fd));
1901 if (r == 0)
1902 r = -errno;
1903 goto finish;
1904 }
1905
1906 FOREACH_DIRENT_ALL(de, d, q = -errno; goto finish) {
1907 int de_fd;
1908
1909 if (dot_or_dot_dot(de->d_name))
1910 continue;
1911
1912 de_fd = openat(fd, de->d_name, O_NOFOLLOW|O_CLOEXEC|O_PATH);
1913 if (de_fd < 0)
1914 q = log_error_errno(errno, "Failed to open() file '%s': %m", de->d_name);
1915 else {
1916 _cleanup_free_ char *de_path = NULL;
1917
1918 de_path = path_join(path, de->d_name);
1919 if (!de_path)
1920 q = log_oom();
1921 else
1922 /* Pass ownership of dirent fd over */
1923 q = item_do(i, de_fd, de_path, action);
1924 }
1925
1926 if (q < 0 && r == 0)
1927 r = q;
1928 }
1929 }
1930 finish:
1931 safe_close(fd);
1932 return r;
1933 }
1934
1935 static int glob_item(Item *i, action_t action) {
1936 _cleanup_globfree_ glob_t g = {
1937 .gl_opendir = (void *(*)(const char *)) opendir_nomod,
1938 };
1939 int r = 0, k;
1940
1941 k = safe_glob(i->path, GLOB_NOSORT|GLOB_BRACE, &g);
1942 if (k < 0 && k != -ENOENT)
1943 return log_error_errno(k, "glob(%s) failed: %m", i->path);
1944
1945 STRV_FOREACH(fn, g.gl_pathv) {
1946 k = action(i, *fn);
1947 if (k < 0 && r == 0)
1948 r = k;
1949 }
1950
1951 return r;
1952 }
1953
1954 static int glob_item_recursively(Item *i, fdaction_t action) {
1955 _cleanup_globfree_ glob_t g = {
1956 .gl_opendir = (void *(*)(const char *)) opendir_nomod,
1957 };
1958 int r = 0, k;
1959
1960 k = safe_glob(i->path, GLOB_NOSORT|GLOB_BRACE, &g);
1961 if (k < 0 && k != -ENOENT)
1962 return log_error_errno(k, "glob(%s) failed: %m", i->path);
1963
1964 STRV_FOREACH(fn, g.gl_pathv) {
1965 _cleanup_close_ int fd = -1;
1966
1967 /* Make sure we won't trigger/follow file object (such as
1968 * device nodes, automounts, ...) pointed out by 'fn' with
1969 * O_PATH. Note, when O_PATH is used, flags other than
1970 * O_CLOEXEC, O_DIRECTORY, and O_NOFOLLOW are ignored. */
1971
1972 fd = open(*fn, O_CLOEXEC|O_NOFOLLOW|O_PATH);
1973 if (fd < 0) {
1974 log_error_errno(errno, "Opening '%s' failed: %m", *fn);
1975 if (r == 0)
1976 r = -errno;
1977 continue;
1978 }
1979
1980 k = item_do(i, fd, *fn, action);
1981 if (k < 0 && r == 0)
1982 r = k;
1983
1984 /* we passed fd ownership to the previous call */
1985 fd = -1;
1986 }
1987
1988 return r;
1989 }
1990
1991 static int rm_if_wrong_type_safe(
1992 mode_t mode,
1993 int parent_fd,
1994 const struct stat *parent_st, /* Only used if follow_links below is true. */
1995 const char *name,
1996 int flags) {
1997 _cleanup_free_ char *parent_name = NULL;
1998 bool follow_links = !FLAGS_SET(flags, AT_SYMLINK_NOFOLLOW);
1999 struct stat st;
2000 int r;
2001
2002 assert(name);
2003 assert((mode & ~S_IFMT) == 0);
2004 assert(!follow_links || parent_st);
2005 assert((flags & ~AT_SYMLINK_NOFOLLOW) == 0);
2006
2007 if (!filename_is_valid(name))
2008 return log_error_errno(SYNTHETIC_ERRNO(EINVAL), "\"%s\" is not a valid filename.", name);
2009
2010 r = fstatat_harder(parent_fd, name, &st, flags, REMOVE_CHMOD | REMOVE_CHMOD_RESTORE);
2011 if (r < 0) {
2012 (void) fd_get_path(parent_fd, &parent_name);
2013 return log_full_errno(r == -ENOENT? LOG_DEBUG : LOG_ERR, r,
2014 "Failed to stat \"%s\" at \"%s\": %m", name, strna(parent_name));
2015 }
2016
2017 /* Fail before removing anything if this is an unsafe transition. */
2018 if (follow_links && unsafe_transition(parent_st, &st)) {
2019 (void) fd_get_path(parent_fd, &parent_name);
2020 return log_error_errno(SYNTHETIC_ERRNO(ENOLINK),
2021 "Unsafe transition from \"%s\" to \"%s\".", parent_name, name);
2022 }
2023
2024 if ((st.st_mode & S_IFMT) == mode)
2025 return 0;
2026
2027 (void) fd_get_path(parent_fd, &parent_name);
2028 log_notice("Wrong file type 0x%x; rm -rf \"%s/%s\"", st.st_mode & S_IFMT, strna(parent_name), name);
2029
2030 /* If the target of the symlink was the wrong type, the link needs to be removed instead of the
2031 * target, so make sure it is identified as a link and not a directory. */
2032 if (follow_links) {
2033 r = fstatat_harder(parent_fd, name, &st, AT_SYMLINK_NOFOLLOW, REMOVE_CHMOD | REMOVE_CHMOD_RESTORE);
2034 if (r < 0)
2035 return log_error_errno(r, "Failed to stat \"%s\" at \"%s\": %m", name, strna(parent_name));
2036 }
2037
2038 /* Do not remove mount points. */
2039 r = fd_is_mount_point(parent_fd, name, follow_links ? AT_SYMLINK_FOLLOW : 0);
2040 if (r < 0)
2041 (void) log_warning_errno(r, "Failed to check if \"%s/%s\" is a mount point: %m; Continuing",
2042 strna(parent_name), name);
2043 else if (r > 0)
2044 return log_error_errno(SYNTHETIC_ERRNO(EBUSY),
2045 "Not removing \"%s/%s\" because it is a mount point.", strna(parent_name), name);
2046
2047 if ((st.st_mode & S_IFMT) == S_IFDIR) {
2048 _cleanup_close_ int child_fd = -1;
2049
2050 child_fd = openat(parent_fd, name, O_NOCTTY | O_CLOEXEC | O_DIRECTORY);
2051 if (child_fd < 0)
2052 return log_error_errno(errno, "Failed to open \"%s\" at \"%s\": %m", name, strna(parent_name));
2053
2054 r = rm_rf_children(TAKE_FD(child_fd), REMOVE_ROOT|REMOVE_SUBVOLUME|REMOVE_PHYSICAL, &st);
2055 if (r < 0)
2056 return log_error_errno(r, "Failed to remove contents of \"%s\" at \"%s\": %m", name, strna(parent_name));
2057
2058 r = unlinkat_harder(parent_fd, name, AT_REMOVEDIR, REMOVE_CHMOD | REMOVE_CHMOD_RESTORE);
2059 } else
2060 r = unlinkat_harder(parent_fd, name, 0, REMOVE_CHMOD | REMOVE_CHMOD_RESTORE);
2061 if (r < 0)
2062 return log_error_errno(r, "Failed to remove \"%s\" at \"%s\": %m", name, strna(parent_name));
2063
2064 /* This is covered by the log_notice "Wrong file type..." It is logged earlier because it gives
2065 * context to other error messages that might follow. */
2066 return -ENOENT;
2067 }
2068
2069 /* If child_mode is non-zero, rm_if_wrong_type_safe will be executed for the last path component. */
2070 static int mkdir_parents_rm_if_wrong_type(mode_t child_mode, const char *path) {
2071 _cleanup_close_ int parent_fd = -1;
2072 struct stat parent_st;
2073 size_t path_len;
2074 int r;
2075
2076 assert(path);
2077 assert((child_mode & ~S_IFMT) == 0);
2078
2079 path_len = strlen(path);
2080
2081 if (!is_path(path))
2082 /* rm_if_wrong_type_safe already logs errors. */
2083 return child_mode != 0 ? rm_if_wrong_type_safe(child_mode, AT_FDCWD, NULL, path, AT_SYMLINK_NOFOLLOW) : 0;
2084
2085 if (child_mode != 0 && endswith(path, "/"))
2086 return log_error_errno(SYNTHETIC_ERRNO(EINVAL),
2087 "Trailing path separators are only allowed if child_mode is not set; got \"%s\"", path);
2088
2089 /* Get the parent_fd and stat. */
2090 parent_fd = openat(AT_FDCWD, path_is_absolute(path) ? "/" : ".", O_NOCTTY | O_CLOEXEC | O_DIRECTORY);
2091 if (parent_fd < 0)
2092 return log_error_errno(errno, "Failed to open root: %m");
2093
2094 if (fstat(parent_fd, &parent_st) < 0)
2095 return log_error_errno(errno, "Failed to stat root: %m");
2096
2097 /* Check every parent directory in the path, except the last component */
2098 for (const char *e = path;;) {
2099 _cleanup_close_ int next_fd = -1;
2100 char t[path_len + 1];
2101 const char *s;
2102
2103 /* Find the start of the next path component. */
2104 s = e + strspn(e, "/");
2105 /* Find the end of the next path component. */
2106 e = s + strcspn(s, "/");
2107
2108 /* Copy the path component to t so it can be a null terminated string. */
2109 *((char*) mempcpy(t, s, e - s)) = 0;
2110
2111 /* Is this the last component? If so, then check the type */
2112 if (*e == 0)
2113 return child_mode != 0 ? rm_if_wrong_type_safe(child_mode, parent_fd, &parent_st, t, AT_SYMLINK_NOFOLLOW) : 0;
2114
2115 r = rm_if_wrong_type_safe(S_IFDIR, parent_fd, &parent_st, t, 0);
2116 /* Remove dangling symlinks. */
2117 if (r == -ENOENT)
2118 r = rm_if_wrong_type_safe(S_IFDIR, parent_fd, &parent_st, t, AT_SYMLINK_NOFOLLOW);
2119 if (r == -ENOENT) {
2120 RUN_WITH_UMASK(0000)
2121 r = mkdirat_label(parent_fd, t, 0755);
2122 if (r < 0) {
2123 _cleanup_free_ char *parent_name = NULL;
2124
2125 (void) fd_get_path(parent_fd, &parent_name);
2126 return log_error_errno(r, "Failed to mkdir \"%s\" at \"%s\": %m", t, strnull(parent_name));
2127 }
2128 } else if (r < 0)
2129 /* rm_if_wrong_type_safe already logs errors. */
2130 return r;
2131
2132 next_fd = RET_NERRNO(openat(parent_fd, t, O_NOCTTY | O_CLOEXEC | O_DIRECTORY));
2133 if (next_fd < 0) {
2134 _cleanup_free_ char *parent_name = NULL;
2135
2136 (void) fd_get_path(parent_fd, &parent_name);
2137 return log_error_errno(next_fd, "Failed to open \"%s\" at \"%s\": %m", t, strnull(parent_name));
2138 }
2139 r = RET_NERRNO(fstat(next_fd, &parent_st));
2140 if (r < 0) {
2141 _cleanup_free_ char *parent_name = NULL;
2142
2143 (void) fd_get_path(parent_fd, &parent_name);
2144 return log_error_errno(r, "Failed to stat \"%s\" at \"%s\": %m", t, strnull(parent_name));
2145 }
2146
2147 CLOSE_AND_REPLACE(parent_fd, next_fd);
2148 }
2149 }
2150
2151 static int mkdir_parents_item(Item *i, mode_t child_mode) {
2152 int r;
2153 if (i->try_replace) {
2154 r = mkdir_parents_rm_if_wrong_type(child_mode, i->path);
2155 if (r < 0 && r != -ENOENT)
2156 return r;
2157 } else
2158 RUN_WITH_UMASK(0000)
2159 (void) mkdir_parents_label(i->path, 0755);
2160
2161 return 0;
2162 }
2163
2164 static int create_item(Item *i) {
2165 CreationMode creation;
2166 int r = 0;
2167
2168 assert(i);
2169
2170 log_debug("Running create action for entry %c %s", (char) i->type, i->path);
2171
2172 switch (i->type) {
2173
2174 case IGNORE_PATH:
2175 case IGNORE_DIRECTORY_PATH:
2176 case REMOVE_PATH:
2177 case RECURSIVE_REMOVE_PATH:
2178 return 0;
2179
2180 case TRUNCATE_FILE:
2181 case CREATE_FILE:
2182 r = mkdir_parents_item(i, S_IFREG);
2183 if (r < 0)
2184 return r;
2185
2186 if ((i->type == CREATE_FILE && i->append_or_force) || i->type == TRUNCATE_FILE)
2187 r = truncate_file(i, i->path);
2188 else
2189 r = create_file(i, i->path);
2190
2191 if (r < 0)
2192 return r;
2193 break;
2194
2195 case COPY_FILES:
2196 r = mkdir_parents_item(i, 0);
2197 if (r < 0)
2198 return r;
2199
2200 r = copy_files(i);
2201 if (r < 0)
2202 return r;
2203 break;
2204
2205 case WRITE_FILE:
2206 r = glob_item(i, write_one_file);
2207 if (r < 0)
2208 return r;
2209
2210 break;
2211
2212 case CREATE_DIRECTORY:
2213 case TRUNCATE_DIRECTORY:
2214 r = mkdir_parents_item(i, S_IFDIR);
2215 if (r < 0)
2216 return r;
2217
2218 r = create_directory(i, i->path);
2219 if (r < 0)
2220 return r;
2221 break;
2222
2223 case CREATE_SUBVOLUME:
2224 case CREATE_SUBVOLUME_INHERIT_QUOTA:
2225 case CREATE_SUBVOLUME_NEW_QUOTA:
2226 r = mkdir_parents_item(i, S_IFDIR);
2227 if (r < 0)
2228 return r;
2229
2230 r = create_subvolume(i, i->path);
2231 if (r < 0)
2232 return r;
2233 break;
2234
2235 case EMPTY_DIRECTORY:
2236 r = glob_item(i, empty_directory);
2237 if (r < 0)
2238 return r;
2239 break;
2240
2241 case CREATE_FIFO:
2242 r = mkdir_parents_item(i, S_IFIFO);
2243 if (r < 0)
2244 return r;
2245
2246 r = create_fifo(i, i->path);
2247 if (r < 0)
2248 return r;
2249 break;
2250
2251 case CREATE_SYMLINK: {
2252 r = mkdir_parents_item(i, S_IFLNK);
2253 if (r < 0)
2254 return r;
2255
2256 mac_selinux_create_file_prepare(i->path, S_IFLNK);
2257 r = symlink(i->argument, i->path);
2258 mac_selinux_create_file_clear();
2259
2260 if (r < 0) {
2261 _cleanup_free_ char *x = NULL;
2262
2263 if (errno != EEXIST)
2264 return log_error_errno(errno, "symlink(%s, %s) failed: %m", i->argument, i->path);
2265
2266 r = readlink_malloc(i->path, &x);
2267 if (r < 0 || !streq(i->argument, x)) {
2268
2269 if (i->append_or_force) {
2270 mac_selinux_create_file_prepare(i->path, S_IFLNK);
2271 r = symlink_atomic(i->argument, i->path);
2272 mac_selinux_create_file_clear();
2273
2274 if (IN_SET(r, -EISDIR, -EEXIST, -ENOTEMPTY)) {
2275 r = rm_rf(i->path, REMOVE_ROOT|REMOVE_PHYSICAL);
2276 if (r < 0)
2277 return log_error_errno(r, "rm -fr %s failed: %m", i->path);
2278
2279 mac_selinux_create_file_prepare(i->path, S_IFLNK);
2280 r = RET_NERRNO(symlink(i->argument, i->path));
2281 mac_selinux_create_file_clear();
2282 }
2283 if (r < 0)
2284 return log_error_errno(r, "symlink(%s, %s) failed: %m", i->argument, i->path);
2285
2286 creation = CREATION_FORCE;
2287 } else {
2288 log_debug("\"%s\" is not a symlink or does not point to the correct path.", i->path);
2289 return 0;
2290 }
2291 } else
2292 creation = CREATION_EXISTING;
2293 } else
2294
2295 creation = CREATION_NORMAL;
2296 log_debug("%s symlink \"%s\".", creation_mode_verb_to_string(creation), i->path);
2297 break;
2298 }
2299
2300 case CREATE_BLOCK_DEVICE:
2301 case CREATE_CHAR_DEVICE:
2302 if (have_effective_cap(CAP_MKNOD) == 0) {
2303 /* In a container we lack CAP_MKNOD. We shouldn't attempt to create the device node in that
2304 * case to avoid noise, and we don't support virtualized devices in containers anyway. */
2305
2306 log_debug("We lack CAP_MKNOD, skipping creation of device node %s.", i->path);
2307 return 0;
2308 }
2309
2310 r = mkdir_parents_item(i, i->type == CREATE_BLOCK_DEVICE ? S_IFBLK : S_IFCHR);
2311 if (r < 0)
2312 return r;
2313
2314 r = create_device(i, i->type == CREATE_BLOCK_DEVICE ? S_IFBLK : S_IFCHR);
2315 if (r < 0)
2316 return r;
2317
2318 break;
2319
2320 case ADJUST_MODE:
2321 case RELABEL_PATH:
2322 r = glob_item(i, path_set_perms);
2323 if (r < 0)
2324 return r;
2325 break;
2326
2327 case RECURSIVE_RELABEL_PATH:
2328 r = glob_item_recursively(i, fd_set_perms);
2329 if (r < 0)
2330 return r;
2331 break;
2332
2333 case SET_XATTR:
2334 r = glob_item(i, path_set_xattrs);
2335 if (r < 0)
2336 return r;
2337 break;
2338
2339 case RECURSIVE_SET_XATTR:
2340 r = glob_item_recursively(i, fd_set_xattrs);
2341 if (r < 0)
2342 return r;
2343 break;
2344
2345 case SET_ACL:
2346 r = glob_item(i, path_set_acls);
2347 if (r < 0)
2348 return r;
2349 break;
2350
2351 case RECURSIVE_SET_ACL:
2352 r = glob_item_recursively(i, fd_set_acls);
2353 if (r < 0)
2354 return r;
2355 break;
2356
2357 case SET_ATTRIBUTE:
2358 r = glob_item(i, path_set_attribute);
2359 if (r < 0)
2360 return r;
2361 break;
2362
2363 case RECURSIVE_SET_ATTRIBUTE:
2364 r = glob_item_recursively(i, fd_set_attribute);
2365 if (r < 0)
2366 return r;
2367 break;
2368 }
2369
2370 return 0;
2371 }
2372
2373 static int remove_item_instance(Item *i, const char *instance) {
2374 int r;
2375
2376 assert(i);
2377
2378 switch (i->type) {
2379
2380 case REMOVE_PATH:
2381 if (remove(instance) < 0 && errno != ENOENT)
2382 return log_error_errno(errno, "rm(%s): %m", instance);
2383
2384 break;
2385
2386 case RECURSIVE_REMOVE_PATH:
2387 /* FIXME: we probably should use dir_cleanup() here instead of rm_rf() so that 'x' is honoured. */
2388 log_debug("rm -rf \"%s\"", instance);
2389 r = rm_rf(instance, REMOVE_ROOT|REMOVE_SUBVOLUME|REMOVE_PHYSICAL);
2390 if (r < 0 && r != -ENOENT)
2391 return log_error_errno(r, "rm_rf(%s): %m", instance);
2392
2393 break;
2394
2395 default:
2396 assert_not_reached();
2397 }
2398
2399 return 0;
2400 }
2401
2402 static int remove_item(Item *i) {
2403 int r;
2404
2405 assert(i);
2406
2407 log_debug("Running remove action for entry %c %s", (char) i->type, i->path);
2408
2409 switch (i->type) {
2410
2411 case TRUNCATE_DIRECTORY:
2412 /* FIXME: we probably should use dir_cleanup() here instead of rm_rf() so that 'x' is honoured. */
2413 log_debug("rm -rf \"%s\"", i->path);
2414 r = rm_rf(i->path, REMOVE_PHYSICAL);
2415 if (r < 0 && r != -ENOENT)
2416 return log_error_errno(r, "rm_rf(%s): %m", i->path);
2417
2418 return 0;
2419
2420 case REMOVE_PATH:
2421 case RECURSIVE_REMOVE_PATH:
2422 return glob_item(i, remove_item_instance);
2423
2424 default:
2425 return 0;
2426 }
2427 }
2428
2429 static char *age_by_to_string(AgeBy ab, bool is_dir) {
2430 static const char ab_map[] = { 'a', 'b', 'c', 'm' };
2431 size_t j = 0;
2432 char *ret;
2433
2434 ret = new(char, ELEMENTSOF(ab_map) + 1);
2435 if (!ret)
2436 return NULL;
2437
2438 for (size_t i = 0; i < ELEMENTSOF(ab_map); i++)
2439 if (FLAGS_SET(ab, 1U << i))
2440 ret[j++] = is_dir ? ascii_toupper(ab_map[i]) : ab_map[i];
2441
2442 ret[j] = 0;
2443 return ret;
2444 }
2445
2446 static int clean_item_instance(Item *i, const char* instance) {
2447 _cleanup_closedir_ DIR *d = NULL;
2448 STRUCT_STATX_DEFINE(sx);
2449 int mountpoint, r;
2450 usec_t cutoff, n;
2451
2452 assert(i);
2453
2454 if (!i->age_set)
2455 return 0;
2456
2457 n = now(CLOCK_REALTIME);
2458 if (n < i->age)
2459 return 0;
2460
2461 cutoff = n - i->age;
2462
2463 d = opendir_nomod(instance);
2464 if (!d) {
2465 if (IN_SET(errno, ENOENT, ENOTDIR)) {
2466 log_debug_errno(errno, "Directory \"%s\": %m", instance);
2467 return 0;
2468 }
2469
2470 return log_error_errno(errno, "Failed to open directory %s: %m", instance);
2471 }
2472
2473 r = statx_fallback(dirfd(d), "", AT_EMPTY_PATH, STATX_MODE|STATX_INO|STATX_ATIME|STATX_MTIME, &sx);
2474 if (r < 0)
2475 return log_error_errno(r, "statx(%s) failed: %m", instance);
2476
2477 if (FLAGS_SET(sx.stx_attributes_mask, STATX_ATTR_MOUNT_ROOT))
2478 mountpoint = FLAGS_SET(sx.stx_attributes, STATX_ATTR_MOUNT_ROOT);
2479 else {
2480 struct stat ps;
2481
2482 if (fstatat(dirfd(d), "..", &ps, AT_SYMLINK_NOFOLLOW) != 0)
2483 return log_error_errno(errno, "stat(%s/..) failed: %m", i->path);
2484
2485 mountpoint =
2486 sx.stx_dev_major != major(ps.st_dev) ||
2487 sx.stx_dev_minor != minor(ps.st_dev) ||
2488 sx.stx_ino != ps.st_ino;
2489 }
2490
2491 if (DEBUG_LOGGING) {
2492 _cleanup_free_ char *ab_f = NULL, *ab_d = NULL;
2493
2494 ab_f = age_by_to_string(i->age_by_file, false);
2495 if (!ab_f)
2496 return log_oom();
2497
2498 ab_d = age_by_to_string(i->age_by_dir, true);
2499 if (!ab_d)
2500 return log_oom();
2501
2502 log_debug("Cleanup threshold for %s \"%s\" is %s; age-by: %s%s",
2503 mountpoint ? "mount point" : "directory",
2504 instance,
2505 FORMAT_TIMESTAMP_STYLE(cutoff, TIMESTAMP_US),
2506 ab_f, ab_d);
2507 }
2508
2509 return dir_cleanup(i, instance, d,
2510 load_statx_timestamp_nsec(&sx.stx_atime),
2511 load_statx_timestamp_nsec(&sx.stx_mtime),
2512 cutoff * NSEC_PER_USEC,
2513 sx.stx_dev_major, sx.stx_dev_minor, mountpoint,
2514 MAX_DEPTH, i->keep_first_level,
2515 i->age_by_file, i->age_by_dir);
2516 }
2517
2518 static int clean_item(Item *i) {
2519 assert(i);
2520
2521 log_debug("Running clean action for entry %c %s", (char) i->type, i->path);
2522
2523 switch (i->type) {
2524 case CREATE_DIRECTORY:
2525 case CREATE_SUBVOLUME:
2526 case CREATE_SUBVOLUME_INHERIT_QUOTA:
2527 case CREATE_SUBVOLUME_NEW_QUOTA:
2528 case TRUNCATE_DIRECTORY:
2529 case IGNORE_PATH:
2530 case COPY_FILES:
2531 clean_item_instance(i, i->path);
2532 return 0;
2533 case EMPTY_DIRECTORY:
2534 case IGNORE_DIRECTORY_PATH:
2535 return glob_item(i, clean_item_instance);
2536 default:
2537 return 0;
2538 }
2539 }
2540
2541 static int process_item(Item *i, OperationMask operation) {
2542 OperationMask todo;
2543 _cleanup_free_ char *_path = NULL;
2544 const char *path;
2545 int r, q, p;
2546
2547 assert(i);
2548
2549 todo = operation & ~i->done;
2550 if (todo == 0) /* Everything already done? */
2551 return 0;
2552
2553 i->done |= operation;
2554
2555 path = i->path;
2556 if (string_is_glob(path)) {
2557 /* We can't easily check whether a glob matches any autofs path, so let's do the check only
2558 * for the non-glob part. */
2559
2560 r = glob_non_glob_prefix(path, &_path);
2561 if (r < 0 && r != -ENOENT)
2562 return log_debug_errno(r, "Failed to deglob path: %m");
2563 if (r >= 0)
2564 path = _path;
2565 }
2566
2567 r = chase_symlinks(path, arg_root, CHASE_NO_AUTOFS|CHASE_NONEXISTENT|CHASE_WARN, NULL, NULL);
2568 if (r == -EREMOTE) {
2569 log_notice_errno(r, "Skipping %s", i->path); /* We log the configured path, to not confuse the user. */
2570 return 0;
2571 }
2572 if (r < 0)
2573 log_debug_errno(r, "Failed to determine whether '%s' is below autofs, ignoring: %m", i->path);
2574
2575 r = FLAGS_SET(operation, OPERATION_CREATE) ? create_item(i) : 0;
2576 /* Failure can only be tolerated for create */
2577 if (i->allow_failure)
2578 r = 0;
2579
2580 q = FLAGS_SET(operation, OPERATION_REMOVE) ? remove_item(i) : 0;
2581 p = FLAGS_SET(operation, OPERATION_CLEAN) ? clean_item(i) : 0;
2582
2583 return r < 0 ? r :
2584 q < 0 ? q :
2585 p;
2586 }
2587
2588 static int process_item_array(ItemArray *array, OperationMask operation) {
2589 int r = 0;
2590 size_t n;
2591
2592 assert(array);
2593
2594 /* Create any parent first. */
2595 if (FLAGS_SET(operation, OPERATION_CREATE) && array->parent)
2596 r = process_item_array(array->parent, operation & OPERATION_CREATE);
2597
2598 /* Clean up all children first */
2599 if ((operation & (OPERATION_REMOVE|OPERATION_CLEAN)) && !set_isempty(array->children)) {
2600 ItemArray *c;
2601
2602 SET_FOREACH(c, array->children) {
2603 int k;
2604
2605 k = process_item_array(c, operation & (OPERATION_REMOVE|OPERATION_CLEAN));
2606 if (k < 0 && r == 0)
2607 r = k;
2608 }
2609 }
2610
2611 for (n = 0; n < array->n_items; n++) {
2612 int k;
2613
2614 k = process_item(array->items + n, operation);
2615 if (k < 0 && r == 0)
2616 r = k;
2617 }
2618
2619 return r;
2620 }
2621
2622 static void item_free_contents(Item *i) {
2623 assert(i);
2624 free(i->path);
2625 free(i->argument);
2626 strv_free(i->xattrs);
2627
2628 #if HAVE_ACL
2629 acl_free(i->acl_access);
2630 acl_free(i->acl_default);
2631 #endif
2632 }
2633
2634 static ItemArray* item_array_free(ItemArray *a) {
2635 size_t n;
2636
2637 if (!a)
2638 return NULL;
2639
2640 for (n = 0; n < a->n_items; n++)
2641 item_free_contents(a->items + n);
2642
2643 set_free(a->children);
2644 free(a->items);
2645 return mfree(a);
2646 }
2647
2648 static int item_compare(const Item *a, const Item *b) {
2649 /* Make sure that the ownership taking item is put first, so
2650 * that we first create the node, and then can adjust it */
2651
2652 if (takes_ownership(a->type) && !takes_ownership(b->type))
2653 return -1;
2654 if (!takes_ownership(a->type) && takes_ownership(b->type))
2655 return 1;
2656
2657 return CMP(a->type, b->type);
2658 }
2659
2660 static bool item_compatible(Item *a, Item *b) {
2661 assert(a);
2662 assert(b);
2663 assert(streq(a->path, b->path));
2664
2665 if (takes_ownership(a->type) && takes_ownership(b->type))
2666 /* check if the items are the same */
2667 return streq_ptr(a->argument, b->argument) &&
2668
2669 a->uid_set == b->uid_set &&
2670 a->uid == b->uid &&
2671
2672 a->gid_set == b->gid_set &&
2673 a->gid == b->gid &&
2674
2675 a->mode_set == b->mode_set &&
2676 a->mode == b->mode &&
2677
2678 a->age_set == b->age_set &&
2679 a->age == b->age &&
2680
2681 a->age_by_file == b->age_by_file &&
2682 a->age_by_dir == b->age_by_dir &&
2683
2684 a->mask_perms == b->mask_perms &&
2685
2686 a->keep_first_level == b->keep_first_level &&
2687
2688 a->major_minor == b->major_minor;
2689
2690 return true;
2691 }
2692
2693 static bool should_include_path(const char *path) {
2694 STRV_FOREACH(prefix, arg_exclude_prefixes)
2695 if (path_startswith(path, *prefix)) {
2696 log_debug("Entry \"%s\" matches exclude prefix \"%s\", skipping.",
2697 path, *prefix);
2698 return false;
2699 }
2700
2701 STRV_FOREACH(prefix, arg_include_prefixes)
2702 if (path_startswith(path, *prefix)) {
2703 log_debug("Entry \"%s\" matches include prefix \"%s\".", path, *prefix);
2704 return true;
2705 }
2706
2707 /* no matches, so we should include this path only if we have no allow list at all */
2708 if (strv_isempty(arg_include_prefixes))
2709 return true;
2710
2711 log_debug("Entry \"%s\" does not match any include prefix, skipping.", path);
2712 return false;
2713 }
2714
2715 static int specifier_expansion_from_arg(const Specifier *specifier_table, Item *i) {
2716 int r;
2717
2718 assert(i);
2719
2720 if (!i->argument)
2721 return 0;
2722
2723 switch (i->type) {
2724 case COPY_FILES:
2725 case CREATE_SYMLINK:
2726 case CREATE_FILE:
2727 case TRUNCATE_FILE:
2728 case WRITE_FILE: {
2729 _cleanup_free_ char *unescaped = NULL, *resolved = NULL;
2730 ssize_t l;
2731
2732 l = cunescape(i->argument, 0, &unescaped);
2733 if (l < 0)
2734 return log_error_errno(l, "Failed to unescape parameter to write: %s", i->argument);
2735
2736 r = specifier_printf(unescaped, PATH_MAX-1, specifier_table, arg_root, NULL, &resolved);
2737 if (r < 0)
2738 return r;
2739
2740 return free_and_replace(i->argument, resolved);
2741 }
2742 case SET_XATTR:
2743 case RECURSIVE_SET_XATTR:
2744 STRV_FOREACH(xattr, i->xattrs) {
2745 _cleanup_free_ char *resolved = NULL;
2746
2747 r = specifier_printf(*xattr, SIZE_MAX, specifier_table, arg_root, NULL, &resolved);
2748 if (r < 0)
2749 return r;
2750
2751 free_and_replace(*xattr, resolved);
2752 }
2753 return 0;
2754
2755 default:
2756 return 0;
2757 }
2758 }
2759
2760 static int patch_var_run(const char *fname, unsigned line, char **path) {
2761 const char *k;
2762 char *n;
2763
2764 assert(path);
2765 assert(*path);
2766
2767 /* Optionally rewrites lines referencing /var/run/, to use /run/ instead. Why bother? tmpfiles merges lines in
2768 * some cases and detects conflicts in others. If files/directories are specified through two equivalent lines
2769 * this is problematic as neither case will be detected. Ideally we'd detect these cases by resolving symlinks
2770 * early, but that's precisely not what we can do here as this code very likely is running very early on, at a
2771 * time where the paths in question are not available yet, or even more importantly, our own tmpfiles rules
2772 * might create the paths that are intermediary to the listed paths. We can't really cover the generic case,
2773 * but the least we can do is cover the specific case of /var/run vs. /run, as /var/run is a legacy name for
2774 * /run only, and we explicitly document that and require that on systemd systems the former is a symlink to
2775 * the latter. Moreover files below this path are by far the primary usecase for tmpfiles.d/. */
2776
2777 k = path_startswith(*path, "/var/run/");
2778 if (isempty(k)) /* Don't complain about other paths than /var/run, and not about /var/run itself either. */
2779 return 0;
2780
2781 n = path_join("/run", k);
2782 if (!n)
2783 return log_oom();
2784
2785 /* Also log about this briefly. We do so at LOG_NOTICE level, as we fixed up the situation automatically, hence
2786 * there's no immediate need for action by the user. However, in the interest of making things less confusing
2787 * to the user, let's still inform the user that these snippets should really be updated. */
2788 log_syntax(NULL, LOG_NOTICE, fname, line, 0,
2789 "Line references path below legacy directory /var/run/, updating %s → %s; please update the tmpfiles.d/ drop-in file accordingly.",
2790 *path, n);
2791
2792 free_and_replace(*path, n);
2793
2794 return 0;
2795 }
2796
2797 static int find_uid(const char *user, uid_t *ret_uid, Hashmap **cache) {
2798 int r;
2799
2800 assert(user);
2801 assert(ret_uid);
2802
2803 /* First: parse as numeric UID string */
2804 r = parse_uid(user, ret_uid);
2805 if (r >= 0)
2806 return r;
2807
2808 /* Second: pass to NSS if we are running "online" */
2809 if (!arg_root)
2810 return get_user_creds(&user, ret_uid, NULL, NULL, NULL, 0);
2811
2812 /* Third, synthesize "root" unconditionally */
2813 if (streq(user, "root")) {
2814 *ret_uid = 0;
2815 return 0;
2816 }
2817
2818 /* Fourth: use fgetpwent() to read /etc/passwd directly, if we are "offline" */
2819 return name_to_uid_offline(arg_root, user, ret_uid, cache);
2820 }
2821
2822 static int find_gid(const char *group, gid_t *ret_gid, Hashmap **cache) {
2823 int r;
2824
2825 assert(group);
2826 assert(ret_gid);
2827
2828 /* First: parse as numeric GID string */
2829 r = parse_gid(group, ret_gid);
2830 if (r >= 0)
2831 return r;
2832
2833 /* Second: pass to NSS if we are running "online" */
2834 if (!arg_root)
2835 return get_group_creds(&group, ret_gid, 0);
2836
2837 /* Third, synthesize "root" unconditionally */
2838 if (streq(group, "root")) {
2839 *ret_gid = 0;
2840 return 0;
2841 }
2842
2843 /* Fourth: use fgetgrent() to read /etc/group directly, if we are "offline" */
2844 return name_to_gid_offline(arg_root, group, ret_gid, cache);
2845 }
2846
2847 static int parse_age_by_from_arg(const char *age_by_str, Item *item) {
2848 AgeBy ab_f = 0, ab_d = 0;
2849
2850 static const struct {
2851 char age_by_chr;
2852 AgeBy age_by_flag;
2853 } age_by_types[] = {
2854 { 'a', AGE_BY_ATIME },
2855 { 'b', AGE_BY_BTIME },
2856 { 'c', AGE_BY_CTIME },
2857 { 'm', AGE_BY_MTIME },
2858 };
2859
2860 assert(age_by_str);
2861 assert(item);
2862
2863 if (isempty(age_by_str))
2864 return -EINVAL;
2865
2866 for (const char *s = age_by_str; *s != 0; s++) {
2867 size_t i;
2868
2869 /* Ignore whitespace. */
2870 if (strchr(WHITESPACE, *s))
2871 continue;
2872
2873 for (i = 0; i < ELEMENTSOF(age_by_types); i++) {
2874 /* Check lower-case for files, upper-case for directories. */
2875 if (*s == age_by_types[i].age_by_chr) {
2876 ab_f |= age_by_types[i].age_by_flag;
2877 break;
2878 } else if (*s == ascii_toupper(age_by_types[i].age_by_chr)) {
2879 ab_d |= age_by_types[i].age_by_flag;
2880 break;
2881 }
2882 }
2883
2884 /* Invalid character. */
2885 if (i >= ELEMENTSOF(age_by_types))
2886 return -EINVAL;
2887 }
2888
2889 /* No match. */
2890 if (ab_f == 0 && ab_d == 0)
2891 return -EINVAL;
2892
2893 item->age_by_file = ab_f > 0 ? ab_f : AGE_BY_DEFAULT_FILE;
2894 item->age_by_dir = ab_d > 0 ? ab_d : AGE_BY_DEFAULT_DIR;
2895
2896 return 0;
2897 }
2898
2899 static int parse_line(
2900 const char *fname,
2901 unsigned line,
2902 const char *buffer,
2903 bool *invalid_config,
2904 Hashmap **uid_cache,
2905 Hashmap **gid_cache) {
2906
2907 _cleanup_free_ char *action = NULL, *mode = NULL, *user = NULL, *group = NULL, *age = NULL, *path = NULL;
2908 _cleanup_(item_free_contents) Item i = {
2909 /* The "age-by" argument considers all file timestamp types by default. */
2910 .age_by_file = AGE_BY_DEFAULT_FILE,
2911 .age_by_dir = AGE_BY_DEFAULT_DIR,
2912 };
2913 ItemArray *existing;
2914 OrderedHashmap *h;
2915 int r, pos;
2916 bool append_or_force = false, boot = false, allow_failure = false, try_replace = false;
2917
2918 assert(fname);
2919 assert(line >= 1);
2920 assert(buffer);
2921
2922 const Specifier specifier_table[] = {
2923 { 'a', specifier_architecture, NULL },
2924 { 'b', specifier_boot_id, NULL },
2925 { 'B', specifier_os_build_id, NULL },
2926 { 'H', specifier_host_name, NULL },
2927 { 'l', specifier_short_host_name, NULL },
2928 { 'm', specifier_machine_id_safe, NULL },
2929 { 'o', specifier_os_id, NULL },
2930 { 'v', specifier_kernel_release, NULL },
2931 { 'w', specifier_os_version_id, NULL },
2932 { 'W', specifier_os_variant_id, NULL },
2933
2934 { 'h', specifier_user_home, NULL },
2935
2936 { 'C', specifier_directory, UINT_TO_PTR(DIRECTORY_CACHE) },
2937 { 'L', specifier_directory, UINT_TO_PTR(DIRECTORY_LOGS) },
2938 { 'S', specifier_directory, UINT_TO_PTR(DIRECTORY_STATE) },
2939 { 't', specifier_directory, UINT_TO_PTR(DIRECTORY_RUNTIME) },
2940
2941 COMMON_CREDS_SPECIFIERS(arg_user ? LOOKUP_SCOPE_USER : LOOKUP_SCOPE_SYSTEM),
2942 COMMON_TMP_SPECIFIERS,
2943 {}
2944 };
2945
2946 r = extract_many_words(
2947 &buffer,
2948 NULL,
2949 EXTRACT_UNQUOTE,
2950 &action,
2951 &path,
2952 &mode,
2953 &user,
2954 &group,
2955 &age,
2956 NULL);
2957 if (r < 0) {
2958 if (IN_SET(r, -EINVAL, -EBADSLT))
2959 /* invalid quoting and such or an unknown specifier */
2960 *invalid_config = true;
2961 return log_syntax(NULL, LOG_ERR, fname, line, r, "Failed to parse line: %m");
2962 } else if (r < 2) {
2963 *invalid_config = true;
2964 return log_syntax(NULL, LOG_ERR, fname, line, SYNTHETIC_ERRNO(EBADMSG), "Syntax error.");
2965 }
2966
2967 if (!empty_or_dash(buffer)) {
2968 i.argument = strdup(buffer);
2969 if (!i.argument)
2970 return log_oom();
2971 }
2972
2973 if (isempty(action)) {
2974 *invalid_config = true;
2975 return log_syntax(NULL, LOG_ERR, fname, line, SYNTHETIC_ERRNO(EBADMSG), "Command too short '%s'.", action);
2976 }
2977
2978 for (pos = 1; action[pos]; pos++) {
2979 if (action[pos] == '!' && !boot)
2980 boot = true;
2981 else if (action[pos] == '+' && !append_or_force)
2982 append_or_force = true;
2983 else if (action[pos] == '-' && !allow_failure)
2984 allow_failure = true;
2985 else if (action[pos] == '=' && !try_replace)
2986 try_replace = true;
2987 else {
2988 *invalid_config = true;
2989 return log_syntax(NULL, LOG_ERR, fname, line, SYNTHETIC_ERRNO(EBADMSG), "Unknown modifiers in command '%s'", action);
2990 }
2991 }
2992
2993 if (boot && !arg_boot) {
2994 log_syntax(NULL, LOG_DEBUG, fname, line, 0, "Ignoring entry %s \"%s\" because --boot is not specified.", action, path);
2995 return 0;
2996 }
2997
2998 i.type = action[0];
2999 i.append_or_force = append_or_force;
3000 i.allow_failure = allow_failure;
3001 i.try_replace = try_replace;
3002
3003 r = specifier_printf(path, PATH_MAX-1, specifier_table, arg_root, NULL, &i.path);
3004 if (r == -ENXIO)
3005 return log_unresolvable_specifier(fname, line);
3006 if (r < 0) {
3007 if (IN_SET(r, -EINVAL, -EBADSLT))
3008 *invalid_config = true;
3009 return log_syntax(NULL, LOG_ERR, fname, line, r, "Failed to replace specifiers in '%s': %m", path);
3010 }
3011
3012 r = patch_var_run(fname, line, &i.path);
3013 if (r < 0)
3014 return r;
3015
3016 switch (i.type) {
3017
3018 case CREATE_DIRECTORY:
3019 case CREATE_SUBVOLUME:
3020 case CREATE_SUBVOLUME_INHERIT_QUOTA:
3021 case CREATE_SUBVOLUME_NEW_QUOTA:
3022 case EMPTY_DIRECTORY:
3023 case TRUNCATE_DIRECTORY:
3024 case CREATE_FIFO:
3025 case IGNORE_PATH:
3026 case IGNORE_DIRECTORY_PATH:
3027 case REMOVE_PATH:
3028 case RECURSIVE_REMOVE_PATH:
3029 case ADJUST_MODE:
3030 case RELABEL_PATH:
3031 case RECURSIVE_RELABEL_PATH:
3032 if (i.argument)
3033 log_syntax(NULL, LOG_WARNING, fname, line, 0, "%c lines don't take argument fields, ignoring.", i.type);
3034
3035 break;
3036
3037 case CREATE_FILE:
3038 case TRUNCATE_FILE:
3039 break;
3040
3041 case CREATE_SYMLINK:
3042 if (!i.argument) {
3043 i.argument = path_join("/usr/share/factory", i.path);
3044 if (!i.argument)
3045 return log_oom();
3046 }
3047 break;
3048
3049 case WRITE_FILE:
3050 if (!i.argument) {
3051 *invalid_config = true;
3052 return log_syntax(NULL, LOG_ERR, fname, line, SYNTHETIC_ERRNO(EBADMSG), "Write file requires argument.");
3053 }
3054 break;
3055
3056 case COPY_FILES:
3057 if (!i.argument) {
3058 i.argument = path_join("/usr/share/factory", i.path);
3059 if (!i.argument)
3060 return log_oom();
3061
3062 } else if (!path_is_absolute(i.argument)) {
3063 *invalid_config = true;
3064 return log_syntax(NULL, LOG_ERR, fname, line, SYNTHETIC_ERRNO(EBADMSG), "Source path '%s' is not absolute.", i.argument);
3065
3066 }
3067
3068 if (!empty_or_root(arg_root)) {
3069 char *p;
3070
3071 p = path_join(arg_root, i.argument);
3072 if (!p)
3073 return log_oom();
3074 free_and_replace(i.argument, p);
3075 }
3076
3077 path_simplify(i.argument);
3078 break;
3079
3080 case CREATE_CHAR_DEVICE:
3081 case CREATE_BLOCK_DEVICE:
3082 if (!i.argument) {
3083 *invalid_config = true;
3084 return log_syntax(NULL, LOG_ERR, fname, line, SYNTHETIC_ERRNO(EBADMSG), "Device file requires argument.");
3085 }
3086
3087 r = parse_dev(i.argument, &i.major_minor);
3088 if (r < 0) {
3089 *invalid_config = true;
3090 return log_syntax(NULL, LOG_ERR, fname, line, r, "Can't parse device file major/minor '%s'.", i.argument);
3091 }
3092
3093 break;
3094
3095 case SET_XATTR:
3096 case RECURSIVE_SET_XATTR:
3097 if (!i.argument) {
3098 *invalid_config = true;
3099 return log_syntax(NULL, LOG_ERR, fname, line, SYNTHETIC_ERRNO(EBADMSG),
3100 "Set extended attribute requires argument.");
3101 }
3102 r = parse_xattrs_from_arg(&i);
3103 if (r < 0)
3104 return r;
3105 break;
3106
3107 case SET_ACL:
3108 case RECURSIVE_SET_ACL:
3109 if (!i.argument) {
3110 *invalid_config = true;
3111 return log_syntax(NULL, LOG_ERR, fname, line, SYNTHETIC_ERRNO(EBADMSG),
3112 "Set ACLs requires argument.");
3113 }
3114 r = parse_acls_from_arg(&i);
3115 if (r < 0)
3116 return r;
3117 break;
3118
3119 case SET_ATTRIBUTE:
3120 case RECURSIVE_SET_ATTRIBUTE:
3121 if (!i.argument) {
3122 *invalid_config = true;
3123 return log_syntax(NULL, LOG_ERR, fname, line, SYNTHETIC_ERRNO(EBADMSG),
3124 "Set file attribute requires argument.");
3125 }
3126 r = parse_attribute_from_arg(&i);
3127 if (IN_SET(r, -EINVAL, -EBADSLT))
3128 *invalid_config = true;
3129 if (r < 0)
3130 return r;
3131 break;
3132
3133 default:
3134 *invalid_config = true;
3135 return log_syntax(NULL, LOG_ERR, fname, line, SYNTHETIC_ERRNO(EBADMSG),
3136 "Unknown command type '%c'.", (char) i.type);
3137 }
3138
3139 if (!path_is_absolute(i.path)) {
3140 *invalid_config = true;
3141 return log_syntax(NULL, LOG_ERR, fname, line, SYNTHETIC_ERRNO(EBADMSG),
3142 "Path '%s' not absolute.", i.path);
3143 }
3144
3145 path_simplify(i.path);
3146
3147 if (!should_include_path(i.path))
3148 return 0;
3149
3150 r = specifier_expansion_from_arg(specifier_table, &i);
3151 if (r == -ENXIO)
3152 return log_unresolvable_specifier(fname, line);
3153 if (r < 0) {
3154 if (IN_SET(r, -EINVAL, -EBADSLT))
3155 *invalid_config = true;
3156 return log_syntax(NULL, LOG_ERR, fname, line, r, "Failed to substitute specifiers in argument: %m");
3157 }
3158
3159 if (!empty_or_root(arg_root)) {
3160 char *p;
3161
3162 p = path_join(arg_root, i.path);
3163 if (!p)
3164 return log_oom();
3165 free_and_replace(i.path, p);
3166 }
3167
3168 if (!empty_or_dash(user)) {
3169 r = find_uid(user, &i.uid, uid_cache);
3170 if (r < 0) {
3171 *invalid_config = true;
3172 return log_syntax(NULL, LOG_ERR, fname, line, r, "Failed to resolve user '%s': %m", user);
3173 }
3174
3175 i.uid_set = true;
3176 }
3177
3178 if (!empty_or_dash(group)) {
3179 r = find_gid(group, &i.gid, gid_cache);
3180 if (r < 0) {
3181 *invalid_config = true;
3182 return log_syntax(NULL, LOG_ERR, fname, line, r, "Failed to resolve group '%s'.", group);
3183 }
3184
3185 i.gid_set = true;
3186 }
3187
3188 if (!empty_or_dash(mode)) {
3189 const char *mm = mode;
3190 unsigned m;
3191
3192 if (*mm == '~') {
3193 i.mask_perms = true;
3194 mm++;
3195 }
3196
3197 r = parse_mode(mm, &m);
3198 if (r < 0) {
3199 *invalid_config = true;
3200 return log_syntax(NULL, LOG_ERR, fname, line, r, "Invalid mode '%s'.", mode);
3201 }
3202
3203 i.mode = m;
3204 i.mode_set = true;
3205 } else
3206 i.mode = IN_SET(i.type, CREATE_DIRECTORY, TRUNCATE_DIRECTORY, CREATE_SUBVOLUME, CREATE_SUBVOLUME_INHERIT_QUOTA, CREATE_SUBVOLUME_NEW_QUOTA) ? 0755 : 0644;
3207
3208 if (!empty_or_dash(age)) {
3209 const char *a = age;
3210 _cleanup_free_ char *seconds = NULL, *age_by = NULL;
3211
3212 if (*a == '~') {
3213 i.keep_first_level = true;
3214 a++;
3215 }
3216
3217 /* Format: "age-by:age"; where age-by is "[abcmABCM]+". */
3218 r = split_pair(a, ":", &age_by, &seconds);
3219 if (r == -ENOMEM)
3220 return log_oom();
3221 if (r < 0 && r != -EINVAL)
3222 return log_error_errno(r, "Failed to parse age-by for '%s': %m", age);
3223 if (r >= 0) {
3224 /* We found a ":", parse the "age-by" part. */
3225 r = parse_age_by_from_arg(age_by, &i);
3226 if (r == -ENOMEM)
3227 return log_oom();
3228 if (r < 0) {
3229 *invalid_config = true;
3230 return log_syntax(NULL, LOG_ERR, fname, line, r, "Invalid age-by '%s'.", age_by);
3231 }
3232
3233 /* For parsing the "age" part, after the ":". */
3234 a = seconds;
3235 }
3236
3237 r = parse_sec(a, &i.age);
3238 if (r < 0) {
3239 *invalid_config = true;
3240 return log_syntax(NULL, LOG_ERR, fname, line, r, "Invalid age '%s'.", a);
3241 }
3242
3243 i.age_set = true;
3244 }
3245
3246 h = needs_glob(i.type) ? globs : items;
3247
3248 existing = ordered_hashmap_get(h, i.path);
3249 if (existing) {
3250 size_t n;
3251
3252 for (n = 0; n < existing->n_items; n++) {
3253 if (!item_compatible(existing->items + n, &i) && !i.append_or_force) {
3254 log_syntax(NULL, LOG_NOTICE, fname, line, 0, "Duplicate line for path \"%s\", ignoring.", i.path);
3255 return 0;
3256 }
3257 }
3258 } else {
3259 existing = new0(ItemArray, 1);
3260 if (!existing)
3261 return log_oom();
3262
3263 r = ordered_hashmap_put(h, i.path, existing);
3264 if (r < 0) {
3265 free(existing);
3266 return log_oom();
3267 }
3268 }
3269
3270 if (!GREEDY_REALLOC(existing->items, existing->n_items + 1))
3271 return log_oom();
3272
3273 existing->items[existing->n_items++] = i;
3274 i = (struct Item) {};
3275
3276 /* Sort item array, to enforce stable ordering of application */
3277 typesafe_qsort(existing->items, existing->n_items, item_compare);
3278
3279 return 0;
3280 }
3281
3282 static int cat_config(char **config_dirs, char **args) {
3283 _cleanup_strv_free_ char **files = NULL;
3284 int r;
3285
3286 r = conf_files_list_with_replacement(arg_root, config_dirs, arg_replace, &files, NULL);
3287 if (r < 0)
3288 return r;
3289
3290 return cat_files(NULL, files, 0);
3291 }
3292
3293 static int exclude_default_prefixes(void) {
3294 int r;
3295
3296 /* Provide an easy way to exclude virtual/memory file systems from what we do here. Useful in
3297 * combination with --root= where we probably don't want to apply stuff to these dirs as they are
3298 * likely over-mounted if the root directory is actually used, and it wouldbe less than ideal to have
3299 * all kinds of files created/adjusted underneath these mount points. */
3300
3301 r = strv_extend_strv(
3302 &arg_exclude_prefixes,
3303 STRV_MAKE("/dev",
3304 "/proc",
3305 "/run",
3306 "/sys"),
3307 true);
3308 if (r < 0)
3309 return log_oom();
3310
3311 return 0;
3312 }
3313
3314 static int help(void) {
3315 _cleanup_free_ char *link = NULL;
3316 int r;
3317
3318 r = terminal_urlify_man("systemd-tmpfiles", "8", &link);
3319 if (r < 0)
3320 return log_oom();
3321
3322 printf("%s [OPTIONS...] [CONFIGURATION FILE...]\n"
3323 "\n%sCreates, deletes and cleans up volatile and temporary files and directories.%s\n\n"
3324 " -h --help Show this help\n"
3325 " --user Execute user configuration\n"
3326 " --version Show package version\n"
3327 " --cat-config Show configuration files\n"
3328 " --create Create marked files/directories\n"
3329 " --clean Clean up marked directories\n"
3330 " --remove Remove marked files/directories\n"
3331 " --boot Execute actions only safe at boot\n"
3332 " --prefix=PATH Only apply rules with the specified prefix\n"
3333 " --exclude-prefix=PATH Ignore rules with the specified prefix\n"
3334 " -E Ignore rules prefixed with /dev, /proc, /run, /sys\n"
3335 " --root=PATH Operate on an alternate filesystem root\n"
3336 " --image=PATH Operate on disk image as filesystem root\n"
3337 " --replace=PATH Treat arguments as replacement for PATH\n"
3338 " --no-pager Do not pipe output into a pager\n"
3339 "\nSee the %s for details.\n",
3340 program_invocation_short_name,
3341 ansi_highlight(),
3342 ansi_normal(),
3343 link);
3344
3345 return 0;
3346 }
3347
3348 static int parse_argv(int argc, char *argv[]) {
3349
3350 enum {
3351 ARG_VERSION = 0x100,
3352 ARG_CAT_CONFIG,
3353 ARG_USER,
3354 ARG_CREATE,
3355 ARG_CLEAN,
3356 ARG_REMOVE,
3357 ARG_BOOT,
3358 ARG_PREFIX,
3359 ARG_EXCLUDE_PREFIX,
3360 ARG_ROOT,
3361 ARG_IMAGE,
3362 ARG_REPLACE,
3363 ARG_NO_PAGER,
3364 };
3365
3366 static const struct option options[] = {
3367 { "help", no_argument, NULL, 'h' },
3368 { "user", no_argument, NULL, ARG_USER },
3369 { "version", no_argument, NULL, ARG_VERSION },
3370 { "cat-config", no_argument, NULL, ARG_CAT_CONFIG },
3371 { "create", no_argument, NULL, ARG_CREATE },
3372 { "clean", no_argument, NULL, ARG_CLEAN },
3373 { "remove", no_argument, NULL, ARG_REMOVE },
3374 { "boot", no_argument, NULL, ARG_BOOT },
3375 { "prefix", required_argument, NULL, ARG_PREFIX },
3376 { "exclude-prefix", required_argument, NULL, ARG_EXCLUDE_PREFIX },
3377 { "root", required_argument, NULL, ARG_ROOT },
3378 { "image", required_argument, NULL, ARG_IMAGE },
3379 { "replace", required_argument, NULL, ARG_REPLACE },
3380 { "no-pager", no_argument, NULL, ARG_NO_PAGER },
3381 {}
3382 };
3383
3384 int c, r;
3385
3386 assert(argc >= 0);
3387 assert(argv);
3388
3389 while ((c = getopt_long(argc, argv, "hE", options, NULL)) >= 0)
3390
3391 switch (c) {
3392
3393 case 'h':
3394 return help();
3395
3396 case ARG_VERSION:
3397 return version();
3398
3399 case ARG_CAT_CONFIG:
3400 arg_cat_config = true;
3401 break;
3402
3403 case ARG_USER:
3404 arg_user = true;
3405 break;
3406
3407 case ARG_CREATE:
3408 arg_operation |= OPERATION_CREATE;
3409 break;
3410
3411 case ARG_CLEAN:
3412 arg_operation |= OPERATION_CLEAN;
3413 break;
3414
3415 case ARG_REMOVE:
3416 arg_operation |= OPERATION_REMOVE;
3417 break;
3418
3419 case ARG_BOOT:
3420 arg_boot = true;
3421 break;
3422
3423 case ARG_PREFIX:
3424 if (strv_push(&arg_include_prefixes, optarg) < 0)
3425 return log_oom();
3426 break;
3427
3428 case ARG_EXCLUDE_PREFIX:
3429 if (strv_push(&arg_exclude_prefixes, optarg) < 0)
3430 return log_oom();
3431 break;
3432
3433 case ARG_ROOT:
3434 r = parse_path_argument(optarg, /* suppress_root= */ false, &arg_root);
3435 if (r < 0)
3436 return r;
3437 break;
3438
3439 case ARG_IMAGE:
3440 #ifdef STANDALONE
3441 return log_error_errno(SYNTHETIC_ERRNO(EOPNOTSUPP),
3442 "This systemd-tmpfiles version is compiled without support for --image=.");
3443 #else
3444 r = parse_path_argument(optarg, /* suppress_root= */ false, &arg_image);
3445 if (r < 0)
3446 return r;
3447 #endif
3448 /* Imply -E here since it makes little sense to create files persistently in the /run mountpoint of a disk image */
3449 _fallthrough_;
3450
3451 case 'E':
3452 r = exclude_default_prefixes();
3453 if (r < 0)
3454 return r;
3455
3456 break;
3457
3458 case ARG_REPLACE:
3459 if (!path_is_absolute(optarg) ||
3460 !endswith(optarg, ".conf"))
3461 return log_error_errno(SYNTHETIC_ERRNO(EINVAL),
3462 "The argument to --replace= must an absolute path to a config file");
3463
3464 arg_replace = optarg;
3465 break;
3466
3467 case ARG_NO_PAGER:
3468 arg_pager_flags |= PAGER_DISABLE;
3469 break;
3470
3471 case '?':
3472 return -EINVAL;
3473
3474 default:
3475 assert_not_reached();
3476 }
3477
3478 if (arg_operation == 0 && !arg_cat_config)
3479 return log_error_errno(SYNTHETIC_ERRNO(EINVAL),
3480 "You need to specify at least one of --clean, --create or --remove.");
3481
3482 if (arg_replace && arg_cat_config)
3483 return log_error_errno(SYNTHETIC_ERRNO(EINVAL),
3484 "Option --replace= is not supported with --cat-config");
3485
3486 if (arg_replace && optind >= argc)
3487 return log_error_errno(SYNTHETIC_ERRNO(EINVAL),
3488 "When --replace= is given, some configuration items must be specified");
3489
3490 if (arg_root && arg_user)
3491 return log_error_errno(SYNTHETIC_ERRNO(EINVAL),
3492 "Combination of --user and --root= is not supported.");
3493
3494 if (arg_image && arg_root)
3495 return log_error_errno(SYNTHETIC_ERRNO(EINVAL), "Please specify either --root= or --image=, the combination of both is not supported.");
3496
3497 return 1;
3498 }
3499
3500 static int read_config_file(char **config_dirs, const char *fn, bool ignore_enoent, bool *invalid_config) {
3501 _cleanup_(hashmap_freep) Hashmap *uid_cache = NULL, *gid_cache = NULL;
3502 _cleanup_fclose_ FILE *_f = NULL;
3503 _cleanup_free_ char *pp = NULL;
3504 unsigned v = 0;
3505 FILE *f;
3506 ItemArray *ia;
3507 int r = 0;
3508
3509 assert(fn);
3510
3511 if (streq(fn, "-")) {
3512 log_debug("Reading config from stdin…");
3513 fn = "<stdin>";
3514 f = stdin;
3515 } else {
3516 r = search_and_fopen(fn, "re", arg_root, (const char**) config_dirs, &_f, &pp);
3517 if (r < 0) {
3518 if (ignore_enoent && r == -ENOENT) {
3519 log_debug_errno(r, "Failed to open \"%s\", ignoring: %m", fn);
3520 return 0;
3521 }
3522
3523 return log_error_errno(r, "Failed to open '%s': %m", fn);
3524 }
3525
3526 log_debug("Reading config file \"%s\"…", pp);
3527 fn = pp;
3528 f = _f;
3529 }
3530
3531 for (;;) {
3532 _cleanup_free_ char *line = NULL;
3533 bool invalid_line = false;
3534 char *l;
3535 int k;
3536
3537 k = read_line(f, LONG_LINE_MAX, &line);
3538 if (k < 0)
3539 return log_error_errno(k, "Failed to read '%s': %m", fn);
3540 if (k == 0)
3541 break;
3542
3543 v++;
3544
3545 l = strstrip(line);
3546 if (IN_SET(*l, 0, '#'))
3547 continue;
3548
3549 k = parse_line(fn, v, l, &invalid_line, &uid_cache, &gid_cache);
3550 if (k < 0) {
3551 if (invalid_line)
3552 /* Allow reporting with a special code if the caller requested this */
3553 *invalid_config = true;
3554 else if (r == 0)
3555 /* The first error becomes our return value */
3556 r = k;
3557 }
3558 }
3559
3560 /* we have to determine age parameter for each entry of type X */
3561 ORDERED_HASHMAP_FOREACH(ia, globs)
3562 for (size_t ni = 0; ni < ia->n_items; ni++) {
3563 ItemArray *ja;
3564 Item *i = ia->items + ni, *candidate_item = NULL;
3565
3566 if (i->type != IGNORE_DIRECTORY_PATH)
3567 continue;
3568
3569 ORDERED_HASHMAP_FOREACH(ja, items)
3570 for (size_t nj = 0; nj < ja->n_items; nj++) {
3571 Item *j = ja->items + nj;
3572
3573 if (!IN_SET(j->type, CREATE_DIRECTORY,
3574 TRUNCATE_DIRECTORY,
3575 CREATE_SUBVOLUME,
3576 CREATE_SUBVOLUME_INHERIT_QUOTA,
3577 CREATE_SUBVOLUME_NEW_QUOTA))
3578 continue;
3579
3580 if (path_equal(j->path, i->path)) {
3581 candidate_item = j;
3582 break;
3583 }
3584
3585 if (candidate_item
3586 ? (path_startswith(j->path, candidate_item->path) && fnmatch(i->path, j->path, FNM_PATHNAME | FNM_PERIOD) == 0)
3587 : path_startswith(i->path, j->path) != NULL)
3588 candidate_item = j;
3589 }
3590
3591 if (candidate_item && candidate_item->age_set) {
3592 i->age = candidate_item->age;
3593 i->age_set = true;
3594 }
3595 }
3596
3597 if (ferror(f)) {
3598 log_error_errno(errno, "Failed to read from file %s: %m", fn);
3599 if (r == 0)
3600 r = -EIO;
3601 }
3602
3603 return r;
3604 }
3605
3606 static int parse_arguments(char **config_dirs, char **args, bool *invalid_config) {
3607 int r;
3608
3609 STRV_FOREACH(arg, args) {
3610 r = read_config_file(config_dirs, *arg, false, invalid_config);
3611 if (r < 0)
3612 return r;
3613 }
3614
3615 return 0;
3616 }
3617
3618 static int read_config_files(char **config_dirs, char **args, bool *invalid_config) {
3619 _cleanup_strv_free_ char **files = NULL;
3620 _cleanup_free_ char *p = NULL;
3621 int r;
3622
3623 r = conf_files_list_with_replacement(arg_root, config_dirs, arg_replace, &files, &p);
3624 if (r < 0)
3625 return r;
3626
3627 STRV_FOREACH(f, files)
3628 if (p && path_equal(*f, p)) {
3629 log_debug("Parsing arguments at position \"%s\"…", *f);
3630
3631 r = parse_arguments(config_dirs, args, invalid_config);
3632 if (r < 0)
3633 return r;
3634 } else
3635 /* Just warn, ignore result otherwise.
3636 * read_config_file() has some debug output, so no need to print anything. */
3637 (void) read_config_file(config_dirs, *f, true, invalid_config);
3638
3639 return 0;
3640 }
3641
3642 static int link_parent(ItemArray *a) {
3643 const char *path;
3644 char *prefix;
3645 int r;
3646
3647 assert(a);
3648
3649 /* Finds the closest "parent" item array for the specified item array. Then registers the specified item array
3650 * as child of it, and fills the parent in, linking them both ways. This allows us to later create parents
3651 * before their children, and clean up/remove children before their parents. */
3652
3653 if (a->n_items <= 0)
3654 return 0;
3655
3656 path = a->items[0].path;
3657 prefix = newa(char, strlen(path) + 1);
3658 PATH_FOREACH_PREFIX(prefix, path) {
3659 ItemArray *j;
3660
3661 j = ordered_hashmap_get(items, prefix);
3662 if (!j)
3663 j = ordered_hashmap_get(globs, prefix);
3664 if (j) {
3665 r = set_ensure_put(&j->children, NULL, a);
3666 if (r < 0)
3667 return log_oom();
3668
3669 a->parent = j;
3670 return 1;
3671 }
3672 }
3673
3674 return 0;
3675 }
3676
3677 DEFINE_PRIVATE_HASH_OPS_WITH_VALUE_DESTRUCTOR(item_array_hash_ops, char, string_hash_func, string_compare_func,
3678 ItemArray, item_array_free);
3679
3680 static int run(int argc, char *argv[]) {
3681 #ifndef STANDALONE
3682 _cleanup_(loop_device_unrefp) LoopDevice *loop_device = NULL;
3683 _cleanup_(decrypted_image_unrefp) DecryptedImage *decrypted_image = NULL;
3684 _cleanup_(umount_and_rmdir_and_freep) char *unlink_dir = NULL;
3685 #endif
3686 _cleanup_strv_free_ char **config_dirs = NULL;
3687 bool invalid_config = false;
3688 ItemArray *a;
3689 enum {
3690 PHASE_REMOVE_AND_CLEAN,
3691 PHASE_CREATE,
3692 _PHASE_MAX
3693 } phase;
3694 int r, k;
3695
3696 r = parse_argv(argc, argv);
3697 if (r <= 0)
3698 return r;
3699
3700 log_setup();
3701
3702 /* We require /proc/ for a lot of our operations, i.e. for adjusting access modes, for anything
3703 * SELinux related, for recursive operation, for xattr, acl and chattr handling, for btrfs stuff and
3704 * a lot more. It's probably the majority of invocations where /proc/ is required. Since people
3705 * apparently invoke it without anyway and are surprised about the failures, let's catch this early
3706 * and output a nice and friendly warning. */
3707 if (proc_mounted() == 0)
3708 return log_error_errno(SYNTHETIC_ERRNO(ENOSYS),
3709 "/proc/ is not mounted, but required for successful operation of systemd-tmpfiles. "
3710 "Please mount /proc/. Alternatively, consider using the --root= or --image= switches.");
3711
3712 /* Descending down file system trees might take a lot of fds */
3713 (void) rlimit_nofile_bump(HIGH_RLIMIT_NOFILE);
3714
3715 if (arg_user) {
3716 r = user_config_paths(&config_dirs);
3717 if (r < 0)
3718 return log_error_errno(r, "Failed to initialize configuration directory list: %m");
3719 } else {
3720 config_dirs = strv_split_nulstr(CONF_PATHS_NULSTR("tmpfiles.d"));
3721 if (!config_dirs)
3722 return log_oom();
3723 }
3724
3725 if (DEBUG_LOGGING) {
3726 _cleanup_free_ char *t = NULL;
3727
3728 STRV_FOREACH(i, config_dirs) {
3729 _cleanup_free_ char *j = NULL;
3730
3731 j = path_join(arg_root, *i);
3732 if (!j)
3733 return log_oom();
3734
3735 if (!strextend(&t, "\n\t", j))
3736 return log_oom();
3737 }
3738
3739 log_debug("Looking for configuration files in (higher priority first):%s", t);
3740 }
3741
3742 if (arg_cat_config) {
3743 pager_open(arg_pager_flags);
3744
3745 return cat_config(config_dirs, argv + optind);
3746 }
3747
3748 umask(0022);
3749
3750 r = mac_selinux_init();
3751 if (r < 0)
3752 return r;
3753
3754 #ifndef STANDALONE
3755 if (arg_image) {
3756 assert(!arg_root);
3757
3758 r = mount_image_privately_interactively(
3759 arg_image,
3760 DISSECT_IMAGE_GENERIC_ROOT |
3761 DISSECT_IMAGE_REQUIRE_ROOT |
3762 DISSECT_IMAGE_VALIDATE_OS |
3763 DISSECT_IMAGE_RELAX_VAR_CHECK |
3764 DISSECT_IMAGE_FSCK |
3765 DISSECT_IMAGE_GROWFS,
3766 &unlink_dir,
3767 &loop_device,
3768 &decrypted_image);
3769 if (r < 0)
3770 return r;
3771
3772 arg_root = strdup(unlink_dir);
3773 if (!arg_root)
3774 return log_oom();
3775 }
3776 #else
3777 assert(!arg_image);
3778 #endif
3779
3780 items = ordered_hashmap_new(&item_array_hash_ops);
3781 globs = ordered_hashmap_new(&item_array_hash_ops);
3782 if (!items || !globs)
3783 return log_oom();
3784
3785 /* If command line arguments are specified along with --replace, read all
3786 * configuration files and insert the positional arguments at the specified
3787 * place. Otherwise, if command line arguments are specified, execute just
3788 * them, and finally, without --replace= or any positional arguments, just
3789 * read configuration and execute it.
3790 */
3791 if (arg_replace || optind >= argc)
3792 r = read_config_files(config_dirs, argv + optind, &invalid_config);
3793 else
3794 r = parse_arguments(config_dirs, argv + optind, &invalid_config);
3795 if (r < 0)
3796 return r;
3797
3798 /* Let's now link up all child/parent relationships */
3799 ORDERED_HASHMAP_FOREACH(a, items) {
3800 r = link_parent(a);
3801 if (r < 0)
3802 return r;
3803 }
3804 ORDERED_HASHMAP_FOREACH(a, globs) {
3805 r = link_parent(a);
3806 if (r < 0)
3807 return r;
3808 }
3809
3810 /* If multiple operations are requested, let's first run the remove/clean operations, and only then the create
3811 * operations. i.e. that we first clean out the platform we then build on. */
3812 for (phase = 0; phase < _PHASE_MAX; phase++) {
3813 OperationMask op;
3814
3815 if (phase == PHASE_REMOVE_AND_CLEAN)
3816 op = arg_operation & (OPERATION_REMOVE|OPERATION_CLEAN);
3817 else if (phase == PHASE_CREATE)
3818 op = arg_operation & OPERATION_CREATE;
3819 else
3820 assert_not_reached();
3821
3822 if (op == 0) /* Nothing requested in this phase */
3823 continue;
3824
3825 /* The non-globbing ones usually create things, hence we apply them first */
3826 ORDERED_HASHMAP_FOREACH(a, items) {
3827 k = process_item_array(a, op);
3828 if (k < 0 && r >= 0)
3829 r = k;
3830 }
3831
3832 /* The globbing ones usually alter things, hence we apply them second. */
3833 ORDERED_HASHMAP_FOREACH(a, globs) {
3834 k = process_item_array(a, op);
3835 if (k < 0 && r >= 0)
3836 r = k;
3837 }
3838 }
3839
3840 if (ERRNO_IS_RESOURCE(r))
3841 return r;
3842 if (invalid_config)
3843 return EX_DATAERR;
3844 if (r < 0)
3845 return EX_CANTCREAT;
3846 return 0;
3847 }
3848
3849 DEFINE_MAIN_FUNCTION_WITH_POSITIVE_FAILURE(run);
Unnamed repository; edit this file 'description' to name the repository.