1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
13 #include <sys/xattr.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"
28 #include "creds-util.h"
30 #include "devnum-util.h"
31 #include "dirent-util.h"
32 #include "dissect-image.h"
37 #include "format-util.h"
39 #include "glob-util.h"
40 #include "hexdecoct.h"
45 #include "main-func.h"
46 #include "missing_stat.h"
47 #include "missing_syscall.h"
48 #include "mkdir-label.h"
49 #include "mount-util.h"
50 #include "mountpoint-util.h"
51 #include "offline-passwd.h"
53 #include "parse-argument.h"
54 #include "parse-util.h"
55 #include "path-lookup.h"
56 #include "path-util.h"
57 #include "pretty-print.h"
58 #include "rlimit-util.h"
60 #include "selinux-util.h"
62 #include "sort-util.h"
63 #include "specifier.h"
64 #include "stdio-util.h"
65 #include "string-table.h"
66 #include "string-util.h"
68 #include "terminal-util.h"
69 #include "umask-util.h"
70 #include "user-util.h"
72 /* This reads all files listed in /etc/tmpfiles.d/?*.conf and creates
73 * them in the file system. This is intended to be used to create
74 * properly owned directories beneath /tmp, /var/tmp, /run, which are
75 * volatile and hence need to be recreated on bootup. */
77 typedef enum OperationMask
{
78 OPERATION_CREATE
= 1 << 0,
79 OPERATION_REMOVE
= 1 << 1,
80 OPERATION_CLEAN
= 1 << 2,
83 typedef enum ItemType
{
84 /* These ones take file names */
86 TRUNCATE_FILE
= 'F', /* deprecated: use f+ */
87 CREATE_DIRECTORY
= 'd',
88 TRUNCATE_DIRECTORY
= 'D',
89 CREATE_SUBVOLUME
= 'v',
90 CREATE_SUBVOLUME_INHERIT_QUOTA
= 'q',
91 CREATE_SUBVOLUME_NEW_QUOTA
= 'Q',
94 CREATE_CHAR_DEVICE
= 'c',
95 CREATE_BLOCK_DEVICE
= 'b',
98 /* These ones take globs */
100 EMPTY_DIRECTORY
= 'e',
102 RECURSIVE_SET_XATTR
= 'T',
104 RECURSIVE_SET_ACL
= 'A',
106 RECURSIVE_SET_ATTRIBUTE
= 'H',
108 IGNORE_DIRECTORY_PATH
= 'X',
110 RECURSIVE_REMOVE_PATH
= 'R',
112 RECURSIVE_RELABEL_PATH
= 'Z',
113 ADJUST_MODE
= 'm', /* legacy, 'z' is identical to this */
117 AGE_BY_ATIME
= 1 << 0,
118 AGE_BY_BTIME
= 1 << 1,
119 AGE_BY_CTIME
= 1 << 2,
120 AGE_BY_MTIME
= 1 << 3,
122 /* All file timestamp types are checked by default. */
123 AGE_BY_DEFAULT_FILE
= AGE_BY_ATIME
| AGE_BY_BTIME
| AGE_BY_CTIME
| AGE_BY_MTIME
,
124 AGE_BY_DEFAULT_DIR
= AGE_BY_ATIME
| AGE_BY_BTIME
| AGE_BY_MTIME
127 typedef struct Item
{
132 void *binary_argument
; /* set if binary data, in which case it takes precedence over 'argument' */
133 size_t binary_argument_size
;
143 AgeBy age_by_file
, age_by_dir
;
146 unsigned attribute_value
;
147 unsigned attribute_mask
;
154 bool attribute_set
:1;
156 bool keep_first_level
:1;
158 bool append_or_force
:1;
160 bool allow_failure
:1;
167 typedef struct ItemArray
{
171 struct ItemArray
*parent
;
175 typedef enum DirectoryType
{
183 static bool arg_cat_config
= false;
184 static bool arg_user
= false;
185 static OperationMask arg_operation
= 0;
186 static bool arg_boot
= false;
187 static PagerFlags arg_pager_flags
= 0;
189 static char **arg_include_prefixes
= NULL
;
190 static char **arg_exclude_prefixes
= NULL
;
191 static char *arg_root
= NULL
;
192 static char *arg_image
= NULL
;
193 static char *arg_replace
= NULL
;
195 #define MAX_DEPTH 256
197 static OrderedHashmap
*items
= NULL
, *globs
= NULL
;
198 static Set
*unix_sockets
= NULL
;
200 STATIC_DESTRUCTOR_REGISTER(items
, ordered_hashmap_freep
);
201 STATIC_DESTRUCTOR_REGISTER(globs
, ordered_hashmap_freep
);
202 STATIC_DESTRUCTOR_REGISTER(unix_sockets
, set_freep
);
203 STATIC_DESTRUCTOR_REGISTER(arg_include_prefixes
, freep
);
204 STATIC_DESTRUCTOR_REGISTER(arg_exclude_prefixes
, freep
);
205 STATIC_DESTRUCTOR_REGISTER(arg_root
, freep
);
206 STATIC_DESTRUCTOR_REGISTER(arg_image
, freep
);
208 static int specifier_machine_id_safe(char specifier
, const void *data
, const char *root
, const void *userdata
, char **ret
);
209 static int specifier_directory(char specifier
, const void *data
, const char *root
, const void *userdata
, char **ret
);
211 static int specifier_machine_id_safe(char specifier
, const void *data
, const char *root
, const void *userdata
, char **ret
) {
214 /* If /etc/machine_id is missing or empty (e.g. in a chroot environment) return a recognizable error
215 * so that the caller can skip the rule gracefully. */
217 r
= specifier_machine_id(specifier
, data
, root
, userdata
, ret
);
218 if (IN_SET(r
, -ENOENT
, -ENOMEDIUM
))
224 static int specifier_directory(char specifier
, const void *data
, const char *root
, const void *userdata
, char **ret
) {
230 static const struct table_entry paths_system
[] = {
231 [DIRECTORY_RUNTIME
] = { SD_PATH_SYSTEM_RUNTIME
},
232 [DIRECTORY_STATE
] = { SD_PATH_SYSTEM_STATE_PRIVATE
},
233 [DIRECTORY_CACHE
] = { SD_PATH_SYSTEM_STATE_CACHE
},
234 [DIRECTORY_LOGS
] = { SD_PATH_SYSTEM_STATE_LOGS
},
237 static const struct table_entry paths_user
[] = {
238 [DIRECTORY_RUNTIME
] = { SD_PATH_USER_RUNTIME
},
239 [DIRECTORY_STATE
] = { SD_PATH_USER_CONFIGURATION
},
240 [DIRECTORY_CACHE
] = { SD_PATH_USER_STATE_CACHE
},
241 [DIRECTORY_LOGS
] = { SD_PATH_USER_CONFIGURATION
, "log" },
244 const struct table_entry
*paths
;
245 _cleanup_free_
char *p
= NULL
;
249 assert_cc(ELEMENTSOF(paths_system
) == ELEMENTSOF(paths_user
));
250 paths
= arg_user
? paths_user
: paths_system
;
252 i
= PTR_TO_UINT(data
);
253 assert(i
< ELEMENTSOF(paths_system
));
255 r
= sd_path_lookup(paths
[i
].type
, paths
[i
].suffix
, &p
);
260 _cleanup_free_
char *j
= NULL
;
262 j
= path_join(arg_root
, p
);
273 static int log_unresolvable_specifier(const char *filename
, unsigned line
) {
274 static bool notified
= false;
276 /* In system mode, this is called when /etc is not fully initialized (e.g.
277 * in a chroot environment) where some specifiers are unresolvable. In user
278 * mode, this is called when some variables are not defined. These cases are
279 * not considered as an error so log at LOG_NOTICE only for the first time
280 * and then downgrade this to LOG_DEBUG for the rest. */
283 notified
? LOG_DEBUG
: LOG_NOTICE
,
285 "Failed to resolve specifier: %s, skipping",
286 arg_user
? "Required $XDG_... variable not defined" : "uninitialized /etc detected");
289 log_notice("All rules containing unresolvable specifiers will be skipped.");
295 static int user_config_paths(char*** ret
) {
296 _cleanup_strv_free_
char **config_dirs
= NULL
, **data_dirs
= NULL
;
297 _cleanup_free_
char *persistent_config
= NULL
, *runtime_config
= NULL
, *data_home
= NULL
;
298 _cleanup_strv_free_
char **res
= NULL
;
301 r
= xdg_user_dirs(&config_dirs
, &data_dirs
);
305 r
= xdg_user_config_dir(&persistent_config
, "/user-tmpfiles.d");
306 if (r
< 0 && r
!= -ENXIO
)
309 r
= xdg_user_runtime_dir(&runtime_config
, "/user-tmpfiles.d");
310 if (r
< 0 && r
!= -ENXIO
)
313 r
= xdg_user_data_dir(&data_home
, "/user-tmpfiles.d");
314 if (r
< 0 && r
!= -ENXIO
)
317 r
= strv_extend_strv_concat(&res
, config_dirs
, "/user-tmpfiles.d");
321 r
= strv_extend(&res
, persistent_config
);
325 r
= strv_extend(&res
, runtime_config
);
329 r
= strv_extend(&res
, data_home
);
333 r
= strv_extend_strv_concat(&res
, data_dirs
, "/user-tmpfiles.d");
337 r
= path_strv_make_absolute_cwd(res
);
341 *ret
= TAKE_PTR(res
);
345 static bool needs_glob(ItemType t
) {
349 IGNORE_DIRECTORY_PATH
,
351 RECURSIVE_REMOVE_PATH
,
355 RECURSIVE_RELABEL_PATH
,
361 RECURSIVE_SET_ATTRIBUTE
);
364 static bool takes_ownership(ItemType t
) {
372 CREATE_SUBVOLUME_INHERIT_QUOTA
,
373 CREATE_SUBVOLUME_NEW_QUOTA
,
381 IGNORE_DIRECTORY_PATH
,
383 RECURSIVE_REMOVE_PATH
);
386 static struct Item
* find_glob(OrderedHashmap
*h
, const char *match
) {
389 ORDERED_HASHMAP_FOREACH(j
, h
) {
392 for (n
= 0; n
< j
->n_items
; n
++) {
393 Item
*item
= j
->items
+ n
;
395 if (fnmatch(item
->path
, match
, FNM_PATHNAME
|FNM_PERIOD
) == 0)
403 static int load_unix_sockets(void) {
404 _cleanup_set_free_ Set
*sockets
= NULL
;
405 _cleanup_fclose_
FILE *f
= NULL
;
411 /* We maintain a cache of the sockets we found in /proc/net/unix to speed things up a little. */
413 f
= fopen("/proc/net/unix", "re");
415 return log_full_errno(errno
== ENOENT
? LOG_DEBUG
: LOG_WARNING
, errno
,
416 "Failed to open /proc/net/unix, ignoring: %m");
419 r
= read_line(f
, LONG_LINE_MAX
, NULL
);
421 return log_warning_errno(r
, "Failed to skip /proc/net/unix header line: %m");
423 return log_warning_errno(SYNTHETIC_ERRNO(EIO
), "Premature end of file reading /proc/net/unix.");
426 _cleanup_free_
char *line
= NULL
;
429 r
= read_line(f
, LONG_LINE_MAX
, &line
);
431 return log_warning_errno(r
, "Failed to read /proc/net/unix line, ignoring: %m");
432 if (r
== 0) /* EOF */
435 p
= strchr(line
, ':');
443 p
+= strspn(p
, WHITESPACE
);
444 p
+= strcspn(p
, WHITESPACE
); /* skip one more word */
445 p
+= strspn(p
, WHITESPACE
);
447 if (!path_is_absolute(p
))
450 r
= set_put_strdup_full(&sockets
, &path_hash_ops_free
, p
);
452 return log_warning_errno(r
, "Failed to add AF_UNIX socket to set, ignoring: %m");
455 unix_sockets
= TAKE_PTR(sockets
);
459 static bool unix_socket_alive(const char *fn
) {
462 if (load_unix_sockets() < 0)
463 return true; /* We don't know, so assume yes */
465 return set_contains(unix_sockets
, fn
);
468 /* Accessors for the argument in binary format */
469 static const void* item_binary_argument(const Item
*i
) {
471 return i
->binary_argument
?: i
->argument
;
474 static size_t item_binary_argument_size(const Item
*i
) {
476 return i
->binary_argument
? i
->binary_argument_size
: strlen_ptr(i
->argument
);
479 static DIR* xopendirat_nomod(int dirfd
, const char *path
) {
482 dir
= xopendirat(dirfd
, path
, O_NOFOLLOW
|O_NOATIME
);
486 log_debug_errno(errno
, "Cannot open %sdirectory \"%s\": %m", dirfd
== AT_FDCWD
? "" : "sub", path
);
490 dir
= xopendirat(dirfd
, path
, O_NOFOLLOW
);
492 log_debug_errno(errno
, "Cannot open %sdirectory \"%s\": %m", dirfd
== AT_FDCWD
? "" : "sub", path
);
497 static DIR* opendir_nomod(const char *path
) {
498 return xopendirat_nomod(AT_FDCWD
, path
);
501 static inline nsec_t
load_statx_timestamp_nsec(const struct statx_timestamp
*ts
) {
505 return NSEC_INFINITY
;
507 if ((nsec_t
) ts
->tv_sec
>= (UINT64_MAX
- ts
->tv_nsec
) / NSEC_PER_SEC
)
508 return NSEC_INFINITY
;
510 return ts
->tv_sec
* NSEC_PER_SEC
+ ts
->tv_nsec
;
513 static bool needs_cleanup(
519 const char *sub_path
,
523 if (FLAGS_SET(age_by
, AGE_BY_MTIME
) && mtime
!= NSEC_INFINITY
&& mtime
>= cutoff
) {
524 /* Follows spelling in stat(1). */
525 log_debug("%s \"%s\": modify time %s is too new.",
526 is_dir
? "Directory" : "File",
528 FORMAT_TIMESTAMP_STYLE(mtime
/ NSEC_PER_USEC
, TIMESTAMP_US
));
533 if (FLAGS_SET(age_by
, AGE_BY_ATIME
) && atime
!= NSEC_INFINITY
&& atime
>= cutoff
) {
534 log_debug("%s \"%s\": access time %s is too new.",
535 is_dir
? "Directory" : "File",
537 FORMAT_TIMESTAMP_STYLE(atime
/ NSEC_PER_USEC
, TIMESTAMP_US
));
543 * Note: Unless explicitly specified by the user, "ctime" is ignored
544 * by default for directories, because we change it when deleting.
546 if (FLAGS_SET(age_by
, AGE_BY_CTIME
) && ctime
!= NSEC_INFINITY
&& ctime
>= cutoff
) {
547 log_debug("%s \"%s\": change time %s is too new.",
548 is_dir
? "Directory" : "File",
550 FORMAT_TIMESTAMP_STYLE(ctime
/ NSEC_PER_USEC
, TIMESTAMP_US
));
555 if (FLAGS_SET(age_by
, AGE_BY_BTIME
) && btime
!= NSEC_INFINITY
&& btime
>= cutoff
) {
556 log_debug("%s \"%s\": birth time %s is too new.",
557 is_dir
? "Directory" : "File",
559 FORMAT_TIMESTAMP_STYLE(btime
/ NSEC_PER_USEC
, TIMESTAMP_US
));
567 static int dir_cleanup(
571 nsec_t self_atime_nsec
,
572 nsec_t self_mtime_nsec
,
578 bool keep_this_level
,
582 bool deleted
= false;
585 FOREACH_DIRENT_ALL(de
, d
, break) {
586 _cleanup_free_
char *sub_path
= NULL
;
587 nsec_t atime_nsec
, mtime_nsec
, ctime_nsec
, btime_nsec
;
589 if (dot_or_dot_dot(de
->d_name
))
592 /* If statx() is supported, use it. It's preferable over fstatat() since it tells us
593 * explicitly where we are looking at a mount point, for free as side information. Determining
594 * the same information without statx() is hard, see the complexity of path_is_mount_point(),
595 * and also much slower as it requires a number of syscalls instead of just one. Hence, when
596 * we have modern statx() we use it instead of fstat() and do proper mount point checks,
597 * while on older kernels's well do traditional st_dev based detection of mount points.
599 * Using statx() for detecting mount points also has the benfit that we handle weird file
600 * systems such as overlayfs better where each file is originating from a different
603 STRUCT_STATX_DEFINE(sx
);
606 dirfd(d
), de
->d_name
,
607 AT_SYMLINK_NOFOLLOW
|AT_NO_AUTOMOUNT
,
608 STATX_TYPE
|STATX_MODE
|STATX_UID
|STATX_ATIME
|STATX_MTIME
|STATX_CTIME
|STATX_BTIME
,
613 /* FUSE, NFS mounts, SELinux might return EACCES */
614 r
= log_full_errno(r
== -EACCES
? LOG_DEBUG
: LOG_ERR
, r
,
615 "statx(%s/%s) failed: %m", p
, de
->d_name
);
619 if (FLAGS_SET(sx
.stx_attributes_mask
, STATX_ATTR_MOUNT_ROOT
)) {
620 /* Yay, we have the mount point API, use it */
621 if (FLAGS_SET(sx
.stx_attributes
, STATX_ATTR_MOUNT_ROOT
)) {
622 log_debug("Ignoring \"%s/%s\": different mount points.", p
, de
->d_name
);
626 /* So we might have statx() but the STATX_ATTR_MOUNT_ROOT flag is not supported, fall
627 * back to traditional stx_dev checking. */
628 if (sx
.stx_dev_major
!= rootdev_major
||
629 sx
.stx_dev_minor
!= rootdev_minor
) {
630 log_debug("Ignoring \"%s/%s\": different filesystem.", p
, de
->d_name
);
634 /* Try to detect bind mounts of the same filesystem instance; they do not differ in device
635 * major/minors. This type of query is not supported on all kernels or filesystem types
637 if (S_ISDIR(sx
.stx_mode
)) {
640 q
= fd_is_mount_point(dirfd(d
), de
->d_name
, 0);
642 log_debug_errno(q
, "Failed to determine whether \"%s/%s\" is a mount point, ignoring: %m", p
, de
->d_name
);
644 log_debug("Ignoring \"%s/%s\": different mount of the same filesystem.", p
, de
->d_name
);
650 atime_nsec
= FLAGS_SET(sx
.stx_mask
, STATX_ATIME
) ? load_statx_timestamp_nsec(&sx
.stx_atime
) : 0;
651 mtime_nsec
= FLAGS_SET(sx
.stx_mask
, STATX_MTIME
) ? load_statx_timestamp_nsec(&sx
.stx_mtime
) : 0;
652 ctime_nsec
= FLAGS_SET(sx
.stx_mask
, STATX_CTIME
) ? load_statx_timestamp_nsec(&sx
.stx_ctime
) : 0;
653 btime_nsec
= FLAGS_SET(sx
.stx_mask
, STATX_BTIME
) ? load_statx_timestamp_nsec(&sx
.stx_btime
) : 0;
655 sub_path
= path_join(p
, de
->d_name
);
661 /* Is there an item configured for this path? */
662 if (ordered_hashmap_get(items
, sub_path
)) {
663 log_debug("Ignoring \"%s\": a separate entry exists.", sub_path
);
667 if (find_glob(globs
, sub_path
)) {
668 log_debug("Ignoring \"%s\": a separate glob exists.", sub_path
);
672 if (S_ISDIR(sx
.stx_mode
)) {
673 _cleanup_closedir_
DIR *sub_dir
= NULL
;
676 streq(de
->d_name
, "lost+found") &&
678 log_debug("Ignoring directory \"%s\".", sub_path
);
683 log_warning("Reached max depth on \"%s\".", sub_path
);
687 sub_dir
= xopendirat_nomod(dirfd(d
), de
->d_name
);
690 r
= log_warning_errno(errno
, "Opening directory \"%s\" failed, ignoring: %m", sub_path
);
695 if (flock(dirfd(sub_dir
), LOCK_EX
|LOCK_NB
) < 0) {
696 log_debug_errno(errno
, "Couldn't acquire shared BSD lock on directory \"%s\", skipping: %m", p
);
702 atime_nsec
, mtime_nsec
, cutoff_nsec
,
703 rootdev_major
, rootdev_minor
,
704 false, maxdepth
-1, false,
705 age_by_file
, age_by_dir
);
710 /* Note: if you are wondering why we don't support the sticky bit for excluding
711 * directories from cleaning like we do it for other file system objects: well, the
712 * sticky bit already has a meaning for directories, so we don't want to overload
715 if (keep_this_level
) {
716 log_debug("Keeping directory \"%s\".", sub_path
);
721 * Check the file timestamps of an entry against the
722 * given cutoff time; delete if it is older.
724 if (!needs_cleanup(atime_nsec
, btime_nsec
, ctime_nsec
, mtime_nsec
,
725 cutoff_nsec
, sub_path
, age_by_dir
, true))
728 log_debug("Removing directory \"%s\".", sub_path
);
729 if (unlinkat(dirfd(d
), de
->d_name
, AT_REMOVEDIR
) < 0)
730 if (!IN_SET(errno
, ENOENT
, ENOTEMPTY
))
731 r
= log_warning_errno(errno
, "Failed to remove directory \"%s\", ignoring: %m", sub_path
);
734 /* Skip files for which the sticky bit is set. These are semantics we define, and are
735 * unknown elsewhere. See XDG_RUNTIME_DIR specification for details. */
736 if (sx
.stx_mode
& S_ISVTX
) {
737 log_debug("Skipping \"%s\": sticky bit set.", sub_path
);
742 S_ISREG(sx
.stx_mode
) &&
744 STR_IN_SET(de
->d_name
,
748 log_debug("Skipping \"%s\".", sub_path
);
752 /* Ignore sockets that are listed in /proc/net/unix */
753 if (S_ISSOCK(sx
.stx_mode
) && unix_socket_alive(sub_path
)) {
754 log_debug("Skipping \"%s\": live socket.", sub_path
);
758 /* Ignore device nodes */
759 if (S_ISCHR(sx
.stx_mode
) || S_ISBLK(sx
.stx_mode
)) {
760 log_debug("Skipping \"%s\": a device.", sub_path
);
764 /* Keep files on this level around if this is requested */
765 if (keep_this_level
) {
766 log_debug("Keeping \"%s\".", sub_path
);
770 if (!needs_cleanup(atime_nsec
, btime_nsec
, ctime_nsec
, mtime_nsec
,
771 cutoff_nsec
, sub_path
, age_by_file
, false))
774 log_debug("Removing \"%s\".", sub_path
);
775 if (unlinkat(dirfd(d
), de
->d_name
, 0) < 0)
777 r
= log_warning_errno(errno
, "Failed to remove \"%s\", ignoring: %m", sub_path
);
785 struct timespec ts
[2];
787 log_debug("Restoring access and modification time on \"%s\": %s, %s",
789 FORMAT_TIMESTAMP_STYLE(self_atime_nsec
/ NSEC_PER_USEC
, TIMESTAMP_US
),
790 FORMAT_TIMESTAMP_STYLE(self_mtime_nsec
/ NSEC_PER_USEC
, TIMESTAMP_US
));
792 timespec_store_nsec(ts
+ 0, self_atime_nsec
);
793 timespec_store_nsec(ts
+ 1, self_mtime_nsec
);
795 /* Restore original directory timestamps */
796 if (futimens(dirfd(d
), ts
) < 0)
797 log_warning_errno(errno
, "Failed to revert timestamps of '%s', ignoring: %m", p
);
803 static bool dangerous_hardlinks(void) {
804 _cleanup_free_
char *value
= NULL
;
805 static int cached
= -1;
808 /* Check whether the fs.protected_hardlinks sysctl is on. If we can't determine it we assume its off, as that's
809 * what the upstream default is. */
814 r
= read_one_line_file("/proc/sys/fs/protected_hardlinks", &value
);
816 log_debug_errno(r
, "Failed to read fs.protected_hardlinks sysctl: %m");
820 r
= parse_boolean(value
);
822 log_debug_errno(r
, "Failed to parse fs.protected_hardlinks sysctl: %m");
830 static bool hardlink_vulnerable(const struct stat
*st
) {
833 return !S_ISDIR(st
->st_mode
) && st
->st_nlink
> 1 && dangerous_hardlinks();
836 static mode_t
process_mask_perms(mode_t mode
, mode_t current
) {
838 if ((current
& 0111) == 0)
840 if ((current
& 0222) == 0)
842 if ((current
& 0444) == 0)
844 if (!S_ISDIR(current
))
845 mode
&= ~07000; /* remove sticky/sgid/suid bit, unless directory */
850 static int fd_set_perms(Item
*i
, int fd
, const char *path
, const struct stat
*st
) {
860 if (!i
->mode_set
&& !i
->uid_set
&& !i
->gid_set
)
864 if (fstat(fd
, &stbuf
) < 0)
865 return log_error_errno(errno
, "fstat(%s) failed: %m", path
);
869 if (hardlink_vulnerable(st
))
870 return log_error_errno(SYNTHETIC_ERRNO(EPERM
),
871 "Refusing to set permissions on hardlinked file %s while the fs.protected_hardlinks sysctl is turned off.",
874 /* Do we need a chown()? */
876 (i
->uid_set
&& i
->uid
!= st
->st_uid
) ||
877 (i
->gid_set
&& i
->gid
!= st
->st_gid
);
879 /* Calculate the mode to apply */
880 new_mode
= i
->mode_set
? (i
->mask_perms
?
881 process_mask_perms(i
->mode
, st
->st_mode
) :
883 (st
->st_mode
& 07777);
885 if (i
->mode_set
&& do_chown
) {
886 /* Before we issue the chmod() let's reduce the access mode to the common bits of the old and
887 * the new mode. That way there's no time window where the file exists under the old owner
888 * with more than the old access modes — and not under the new owner with more than the new
889 * access modes either. */
891 if (S_ISLNK(st
->st_mode
))
892 log_debug("Skipping temporary mode fix for symlink %s.", path
);
894 mode_t m
= new_mode
& st
->st_mode
; /* Mask new mode by old mode */
896 if (((m
^ st
->st_mode
) & 07777) == 0)
897 log_debug("\"%s\" matches temporary mode %o already.", path
, m
);
899 log_debug("Temporarily changing \"%s\" to mode %o.", path
, m
);
900 r
= fchmod_opath(fd
, m
);
902 return log_error_errno(r
, "fchmod() of %s failed: %m", path
);
908 log_debug("Changing \"%s\" to owner "UID_FMT
":"GID_FMT
,
910 i
->uid_set
? i
->uid
: UID_INVALID
,
911 i
->gid_set
? i
->gid
: GID_INVALID
);
915 i
->uid_set
? i
->uid
: UID_INVALID
,
916 i
->gid_set
? i
->gid
: GID_INVALID
,
918 return log_error_errno(errno
, "fchownat() of %s failed: %m", path
);
921 /* Now, apply the final mode. We do this in two cases: when the user set a mode explicitly, or after a
922 * chown(), since chown()'s mangle the access mode in regards to sgid/suid in some conditions. */
923 if (i
->mode_set
|| do_chown
) {
924 if (S_ISLNK(st
->st_mode
))
925 log_debug("Skipping mode fix for symlink %s.", path
);
927 /* Check if the chmod() is unnecessary. Note that if we did a chown() before we always
928 * chmod() here again, since it might have mangled the bits. */
929 if (!do_chown
&& ((new_mode
^ st
->st_mode
) & 07777) == 0)
930 log_debug("\"%s\" matches mode %o already.", path
, new_mode
);
932 log_debug("Changing \"%s\" to mode %o.", path
, new_mode
);
933 r
= fchmod_opath(fd
, new_mode
);
935 return log_error_errno(r
, "fchmod() of %s failed: %m", path
);
941 return label_fix_full(fd
, /* inode_path= */ NULL
, /* label_path= */ path
, 0);
944 static int path_open_parent_safe(const char *path
) {
945 _cleanup_free_
char *dn
= NULL
;
948 if (!path_is_normalized(path
))
949 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "Failed to open parent of '%s': path not normalized.", path
);
951 r
= path_extract_directory(path
, &dn
);
953 return log_error_errno(r
, "Unable to determine parent directory of '%s': %m", path
);
955 r
= chase_symlinks(dn
, arg_root
, CHASE_SAFE
|CHASE_WARN
, NULL
, &fd
);
956 if (r
== -ENOLINK
) /* Unsafe symlink: already covered by CHASE_WARN */
959 return log_error_errno(r
, "Failed to open path '%s': %m", dn
);
964 static int path_open_safe(const char *path
) {
967 /* path_open_safe() returns a file descriptor opened with O_PATH after
968 * verifying that the path doesn't contain unsafe transitions, except
969 * for its final component as the function does not follow symlink. */
973 if (!path_is_normalized(path
))
974 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "Failed to open invalid path '%s'.", path
);
976 r
= chase_symlinks(path
, arg_root
, CHASE_SAFE
|CHASE_WARN
|CHASE_NOFOLLOW
, NULL
, &fd
);
978 return r
; /* Unsafe symlink: already covered by CHASE_WARN */
980 return log_error_errno(r
, "Failed to open path %s: %m", path
);
985 static int path_set_perms(Item
*i
, const char *path
) {
986 _cleanup_close_
int fd
= -1;
991 fd
= path_open_safe(path
);
995 return fd_set_perms(i
, fd
, path
, NULL
);
998 static int parse_xattrs_from_arg(Item
*i
) {
1004 assert_se(p
= i
->argument
);
1006 _cleanup_free_
char *name
= NULL
, *value
= NULL
, *xattr
= NULL
;
1008 r
= extract_first_word(&p
, &xattr
, NULL
, EXTRACT_UNQUOTE
|EXTRACT_CUNESCAPE
);
1010 log_warning_errno(r
, "Failed to parse extended attribute '%s', ignoring: %m", p
);
1014 r
= split_pair(xattr
, "=", &name
, &value
);
1016 log_warning_errno(r
, "Failed to parse extended attribute, ignoring: %s", xattr
);
1020 if (isempty(name
) || isempty(value
)) {
1021 log_warning("Malformed extended attribute found, ignoring: %s", xattr
);
1025 if (strv_push_pair(&i
->xattrs
, name
, value
) < 0)
1028 name
= value
= NULL
;
1034 static int fd_set_xattrs(Item
*i
, int fd
, const char *path
, const struct stat
*st
) {
1039 STRV_FOREACH_PAIR(name
, value
, i
->xattrs
) {
1040 log_debug("Setting extended attribute '%s=%s' on %s.", *name
, *value
, path
);
1041 if (setxattr(FORMAT_PROC_FD_PATH(fd
), *name
, *value
, strlen(*value
), 0) < 0)
1042 return log_error_errno(errno
, "Setting extended attribute %s=%s on %s failed: %m",
1043 *name
, *value
, path
);
1048 static int path_set_xattrs(Item
*i
, const char *path
) {
1049 _cleanup_close_
int fd
= -1;
1054 fd
= path_open_safe(path
);
1058 return fd_set_xattrs(i
, fd
, path
, NULL
);
1061 static int parse_acls_from_arg(Item
*item
) {
1067 /* If append_or_force (= modify) is set, we will not modify the acl
1068 * afterwards, so the mask can be added now if necessary. */
1070 r
= parse_acl(item
->argument
, &item
->acl_access
, &item
->acl_default
, !item
->append_or_force
);
1072 log_warning_errno(r
, "Failed to parse ACL \"%s\": %m. Ignoring", item
->argument
);
1074 log_warning("ACLs are not supported. Ignoring.");
1081 static int path_set_acl(const char *path
, const char *pretty
, acl_type_t type
, acl_t acl
, bool modify
) {
1082 _cleanup_(acl_free_charpp
) char *t
= NULL
;
1083 _cleanup_(acl_freep
) acl_t dup
= NULL
;
1086 /* Returns 0 for success, positive error if already warned,
1087 * negative error otherwise. */
1090 r
= acls_for_file(path
, type
, acl
, &dup
);
1094 r
= calc_acl_mask_if_needed(&dup
);
1102 /* the mask was already added earlier if needed */
1105 r
= add_base_acls_if_needed(&dup
, path
);
1109 t
= acl_to_any_text(dup
, NULL
, ',', TEXT_ABBREVIATE
);
1110 log_debug("Setting %s ACL %s on %s.",
1111 type
== ACL_TYPE_ACCESS
? "access" : "default",
1114 r
= acl_set_file(path
, type
, dup
);
1116 if (ERRNO_IS_NOT_SUPPORTED(errno
))
1117 /* No error if filesystem doesn't support ACLs. Return negative. */
1120 /* Return positive to indicate we already warned */
1121 return -log_error_errno(errno
,
1122 "Setting %s ACL \"%s\" on %s failed: %m",
1123 type
== ACL_TYPE_ACCESS
? "access" : "default",
1130 static int fd_set_acls(Item
*item
, int fd
, const char *path
, const struct stat
*st
) {
1140 if (fstat(fd
, &stbuf
) < 0)
1141 return log_error_errno(errno
, "fstat(%s) failed: %m", path
);
1145 if (hardlink_vulnerable(st
))
1146 return log_error_errno(SYNTHETIC_ERRNO(EPERM
),
1147 "Refusing to set ACLs on hardlinked file %s while the fs.protected_hardlinks sysctl is turned off.",
1150 if (S_ISLNK(st
->st_mode
)) {
1151 log_debug("Skipping ACL fix for symlink %s.", path
);
1155 if (item
->acl_access
)
1156 r
= path_set_acl(FORMAT_PROC_FD_PATH(fd
), path
, ACL_TYPE_ACCESS
, item
->acl_access
, item
->append_or_force
);
1158 /* set only default acls to folders */
1159 if (r
== 0 && item
->acl_default
&& S_ISDIR(st
->st_mode
))
1160 r
= path_set_acl(FORMAT_PROC_FD_PATH(fd
), path
, ACL_TYPE_DEFAULT
, item
->acl_default
, item
->append_or_force
);
1162 if (ERRNO_IS_NOT_SUPPORTED(r
)) {
1163 log_debug_errno(r
, "ACLs not supported by file system at %s", path
);
1168 return -r
; /* already warned */
1170 /* The above procfs paths don't work if /proc is not mounted. */
1171 if (r
== -ENOENT
&& proc_mounted() == 0)
1175 return log_error_errno(r
, "ACL operation on \"%s\" failed: %m", path
);
1180 static int path_set_acls(Item
*item
, const char *path
) {
1183 _cleanup_close_
int fd
= -1;
1188 fd
= path_open_safe(path
);
1192 r
= fd_set_acls(item
, fd
, path
, NULL
);
1197 static int parse_attribute_from_arg(Item
*item
) {
1199 static const struct {
1203 { 'A', FS_NOATIME_FL
}, /* do not update atime */
1204 { 'S', FS_SYNC_FL
}, /* Synchronous updates */
1205 { 'D', FS_DIRSYNC_FL
}, /* dirsync behaviour (directories only) */
1206 { 'a', FS_APPEND_FL
}, /* writes to file may only append */
1207 { 'c', FS_COMPR_FL
}, /* Compress file */
1208 { 'd', FS_NODUMP_FL
}, /* do not dump file */
1209 { 'e', FS_EXTENT_FL
}, /* Extents */
1210 { 'i', FS_IMMUTABLE_FL
}, /* Immutable file */
1211 { 'j', FS_JOURNAL_DATA_FL
}, /* Reserved for ext3 */
1212 { 's', FS_SECRM_FL
}, /* Secure deletion */
1213 { 'u', FS_UNRM_FL
}, /* Undelete */
1214 { 't', FS_NOTAIL_FL
}, /* file tail should not be merged */
1215 { 'T', FS_TOPDIR_FL
}, /* Top of directory hierarchies */
1216 { 'C', FS_NOCOW_FL
}, /* Do not cow file */
1217 { 'P', FS_PROJINHERIT_FL
}, /* Inherit the quota project ID */
1226 unsigned value
= 0, mask
= 0;
1236 } else if (*p
== '-') {
1239 } else if (*p
== '=') {
1245 if (isempty(p
) && mode
!= MODE_SET
)
1246 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
1247 "Setting file attribute on '%s' needs an attribute specification.",
1250 for (; p
&& *p
; p
++) {
1253 for (i
= 0; i
< ELEMENTSOF(attributes
); i
++)
1254 if (*p
== attributes
[i
].character
)
1257 if (i
>= ELEMENTSOF(attributes
))
1258 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
1259 "Unknown file attribute '%c' on '%s'.",
1262 v
= attributes
[i
].value
;
1264 SET_FLAG(value
, v
, IN_SET(mode
, MODE_ADD
, MODE_SET
));
1269 if (mode
== MODE_SET
)
1270 mask
|= CHATTR_ALL_FL
;
1274 item
->attribute_mask
= mask
;
1275 item
->attribute_value
= value
;
1276 item
->attribute_set
= true;
1281 static int fd_set_attribute(Item
*item
, int fd
, const char *path
, const struct stat
*st
) {
1282 _cleanup_close_
int procfs_fd
= -1;
1291 if (!item
->attribute_set
|| item
->attribute_mask
== 0)
1295 if (fstat(fd
, &stbuf
) < 0)
1296 return log_error_errno(errno
, "fstat(%s) failed: %m", path
);
1300 /* Issuing the file attribute ioctls on device nodes is not
1301 * safe, as that will be delivered to the drivers, not the
1302 * file system containing the device node. */
1303 if (!S_ISREG(st
->st_mode
) && !S_ISDIR(st
->st_mode
))
1304 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
1305 "Setting file flags is only supported on regular files and directories, cannot set on '%s'.",
1308 f
= item
->attribute_value
& item
->attribute_mask
;
1310 /* Mask away directory-specific flags */
1311 if (!S_ISDIR(st
->st_mode
))
1312 f
&= ~FS_DIRSYNC_FL
;
1314 procfs_fd
= fd_reopen(fd
, O_RDONLY
|O_CLOEXEC
|O_NOATIME
);
1316 return log_error_errno(procfs_fd
, "Failed to re-open '%s': %m", path
);
1318 unsigned previous
, current
;
1319 r
= chattr_full(NULL
, procfs_fd
, f
, item
->attribute_mask
, &previous
, ¤t
, CHATTR_FALLBACK_BITWISE
);
1321 log_warning("Cannot set file attributes for '%s', maybe due to incompatibility in specified attributes, "
1322 "previous=0x%08x, current=0x%08x, expected=0x%08x, ignoring.",
1323 path
, previous
, current
, (previous
& ~item
->attribute_mask
) | (f
& item
->attribute_mask
));
1325 log_full_errno(ERRNO_IS_NOT_SUPPORTED(r
) ? LOG_DEBUG
: LOG_WARNING
, r
,
1326 "Cannot set file attributes for '%s', value=0x%08x, mask=0x%08x, ignoring: %m",
1327 path
, item
->attribute_value
, item
->attribute_mask
);
1332 static int path_set_attribute(Item
*item
, const char *path
) {
1333 _cleanup_close_
int fd
= -1;
1335 if (!item
->attribute_set
|| item
->attribute_mask
== 0)
1338 fd
= path_open_safe(path
);
1342 return fd_set_attribute(item
, fd
, path
, NULL
);
1345 static int write_argument_data(Item
*i
, int fd
, const char *path
) {
1352 if (item_binary_argument_size(i
) == 0)
1355 assert(item_binary_argument(i
));
1357 log_debug("Writing to \"%s\".", path
);
1359 r
= loop_write(fd
, item_binary_argument(i
), item_binary_argument_size(i
), /* do_poll= */ false);
1361 return log_error_errno(r
, "Failed to write file \"%s\": %m", path
);
1366 static int write_one_file(Item
*i
, const char *path
) {
1367 _cleanup_close_
int fd
= -1, dir_fd
= -1;
1368 _cleanup_free_
char *bn
= NULL
;
1373 assert(i
->type
== WRITE_FILE
);
1375 r
= path_extract_filename(path
, &bn
);
1377 return log_error_errno(r
, "Failed to extract filename from path '%s': %m", path
);
1378 if (r
== O_DIRECTORY
)
1379 return log_error_errno(SYNTHETIC_ERRNO(EISDIR
), "Cannot open path '%s' for writing, is a directory.", path
);
1381 /* Validate the path and keep the fd on the directory for opening the file so we're sure that it
1382 * can't be changed behind our back. */
1383 dir_fd
= path_open_parent_safe(path
);
1387 /* Follows symlinks */
1388 fd
= openat(dir_fd
, bn
,
1389 O_NONBLOCK
|O_CLOEXEC
|O_WRONLY
|O_NOCTTY
|(i
->append_or_force
? O_APPEND
: 0),
1392 if (errno
== ENOENT
) {
1393 log_debug_errno(errno
, "Not writing missing file \"%s\": %m", path
);
1397 if (i
->allow_failure
)
1398 return log_debug_errno(errno
, "Failed to open file \"%s\", ignoring: %m", path
);
1400 return log_error_errno(errno
, "Failed to open file \"%s\": %m", path
);
1403 /* 'w' is allowed to write into any kind of files. */
1405 r
= write_argument_data(i
, fd
, path
);
1409 return fd_set_perms(i
, fd
, path
, NULL
);
1412 static int create_file(Item
*i
, const char *path
) {
1413 _cleanup_close_
int fd
= -1, dir_fd
= -1;
1414 _cleanup_free_
char *bn
= NULL
;
1415 struct stat stbuf
, *st
= NULL
;
1420 assert(i
->type
== CREATE_FILE
);
1422 /* 'f' operates on regular files exclusively. */
1424 r
= path_extract_filename(path
, &bn
);
1426 return log_error_errno(r
, "Failed to extract filename from path '%s': %m", path
);
1427 if (r
== O_DIRECTORY
)
1428 return log_error_errno(SYNTHETIC_ERRNO(EISDIR
), "Cannot open path '%s' for writing, is a directory.", path
);
1430 /* Validate the path and keep the fd on the directory for opening the file so we're sure that it
1431 * can't be changed behind our back. */
1432 dir_fd
= path_open_parent_safe(path
);
1436 RUN_WITH_UMASK(0000) {
1437 mac_selinux_create_file_prepare(path
, S_IFREG
);
1438 fd
= RET_NERRNO(openat(dir_fd
, bn
, O_CREAT
|O_EXCL
|O_NOFOLLOW
|O_NONBLOCK
|O_CLOEXEC
|O_WRONLY
|O_NOCTTY
, i
->mode
));
1439 mac_selinux_create_file_clear();
1443 /* Even on a read-only filesystem, open(2) returns EEXIST if the
1444 * file already exists. It returns EROFS only if it needs to
1445 * create the file. */
1447 return log_error_errno(fd
, "Failed to create file %s: %m", path
);
1449 /* Re-open the file. At that point it must exist since open(2)
1450 * failed with EEXIST. We still need to check if the perms/mode
1451 * need to be changed. For read-only filesystems, we let
1452 * fd_set_perms() report the error if the perms need to be
1454 fd
= openat(dir_fd
, bn
, O_NOFOLLOW
|O_CLOEXEC
|O_PATH
, i
->mode
);
1456 return log_error_errno(errno
, "Failed to re-open file %s: %m", path
);
1458 if (fstat(fd
, &stbuf
) < 0)
1459 return log_error_errno(errno
, "stat(%s) failed: %m", path
);
1461 if (!S_ISREG(stbuf
.st_mode
))
1462 return log_error_errno(SYNTHETIC_ERRNO(EEXIST
),
1463 "%s exists and is not a regular file.",
1467 } else if (item_binary_argument(i
)) {
1468 r
= write_argument_data(i
, fd
, path
);
1473 return fd_set_perms(i
, fd
, path
, st
);
1476 static int truncate_file(Item
*i
, const char *path
) {
1477 _cleanup_close_
int fd
= -1, dir_fd
= -1;
1478 _cleanup_free_
char *bn
= NULL
;
1479 struct stat stbuf
, *st
= NULL
;
1485 assert(i
->type
== TRUNCATE_FILE
|| (i
->type
== CREATE_FILE
&& i
->append_or_force
));
1487 /* We want to operate on regular file exclusively especially since O_TRUNC is unspecified if the file
1488 * is neither a regular file nor a fifo nor a terminal device. Therefore we first open the file and
1489 * make sure it's a regular one before truncating it. */
1491 r
= path_extract_filename(path
, &bn
);
1493 return log_error_errno(r
, "Failed to extract filename from path '%s': %m", path
);
1494 if (r
== O_DIRECTORY
)
1495 return log_error_errno(SYNTHETIC_ERRNO(EISDIR
), "Cannot open path '%s' for truncation, is a directory.", path
);
1497 /* Validate the path and keep the fd on the directory for opening the file so we're sure that it
1498 * can't be changed behind our back. */
1499 dir_fd
= path_open_parent_safe(path
);
1503 RUN_WITH_UMASK(0000) {
1504 mac_selinux_create_file_prepare(path
, S_IFREG
);
1505 fd
= RET_NERRNO(openat(dir_fd
, bn
, O_CREAT
|O_NOFOLLOW
|O_NONBLOCK
|O_CLOEXEC
|O_WRONLY
|O_NOCTTY
, i
->mode
));
1506 mac_selinux_create_file_clear();
1511 return log_error_errno(fd
, "Failed to open/create file %s: %m", path
);
1513 /* On a read-only filesystem, we don't want to fail if the
1514 * target is already empty and the perms are set. So we still
1515 * proceed with the sanity checks and let the remaining
1516 * operations fail with EROFS if they try to modify the target
1519 fd
= openat(dir_fd
, bn
, O_NOFOLLOW
|O_CLOEXEC
|O_PATH
, i
->mode
);
1521 if (errno
== ENOENT
)
1522 return log_error_errno(SYNTHETIC_ERRNO(EROFS
),
1523 "Cannot create file %s on a read-only file system.",
1526 return log_error_errno(errno
, "Failed to re-open file %s: %m", path
);
1532 if (fstat(fd
, &stbuf
) < 0)
1533 return log_error_errno(errno
, "stat(%s) failed: %m", path
);
1535 if (!S_ISREG(stbuf
.st_mode
))
1536 return log_error_errno(SYNTHETIC_ERRNO(EEXIST
),
1537 "%s exists and is not a regular file.",
1540 if (stbuf
.st_size
> 0) {
1541 if (ftruncate(fd
, 0) < 0) {
1542 r
= erofs
? -EROFS
: -errno
;
1543 return log_error_errno(r
, "Failed to truncate file %s: %m", path
);
1548 log_debug("\"%s\" has been created.", path
);
1550 if (item_binary_argument(i
)) {
1551 r
= write_argument_data(i
, fd
, path
);
1556 return fd_set_perms(i
, fd
, path
, st
);
1559 static int copy_files(Item
*i
) {
1560 _cleanup_close_
int dfd
= -1, fd
= -1;
1561 _cleanup_free_
char *bn
= NULL
;
1564 log_debug("Copying tree \"%s\" to \"%s\".", i
->argument
, i
->path
);
1566 r
= path_extract_filename(i
->path
, &bn
);
1568 return log_error_errno(r
, "Failed to extract filename from path '%s': %m", i
->path
);
1570 /* Validate the path and use the returned directory fd for copying the target so we're sure that the
1571 * path can't be changed behind our back. */
1572 dfd
= path_open_parent_safe(i
->path
);
1576 r
= copy_tree_at(AT_FDCWD
, i
->argument
,
1578 i
->uid_set
? i
->uid
: UID_INVALID
,
1579 i
->gid_set
? i
->gid
: GID_INVALID
,
1580 COPY_REFLINK
| COPY_MERGE_EMPTY
| COPY_MAC_CREATE
| COPY_HARDLINKS
);
1584 /* If the target already exists on read-only filesystems, trying
1585 * to create the target will not fail with EEXIST but with
1587 if (r
== -EROFS
&& faccessat(dfd
, bn
, F_OK
, AT_SYMLINK_NOFOLLOW
) == 0)
1591 return log_error_errno(r
, "Failed to copy files to %s: %m", i
->path
);
1593 if (stat(i
->argument
, &a
) < 0)
1594 return log_error_errno(errno
, "stat(%s) failed: %m", i
->argument
);
1596 if (fstatat(dfd
, bn
, &b
, AT_SYMLINK_NOFOLLOW
) < 0)
1597 return log_error_errno(errno
, "stat(%s) failed: %m", i
->path
);
1599 if ((a
.st_mode
^ b
.st_mode
) & S_IFMT
) {
1600 log_debug("Can't copy to %s, file exists already and is of different type", i
->path
);
1605 fd
= openat(dfd
, bn
, O_NOFOLLOW
|O_CLOEXEC
|O_PATH
);
1607 return log_error_errno(errno
, "Failed to openat(%s): %m", i
->path
);
1609 return fd_set_perms(i
, fd
, i
->path
, NULL
);
1617 _CREATION_MODE_INVALID
= -EINVAL
,
1620 static const char *const creation_mode_verb_table
[_CREATION_MODE_MAX
] = {
1621 [CREATION_NORMAL
] = "Created",
1622 [CREATION_EXISTING
] = "Found existing",
1623 [CREATION_FORCE
] = "Created replacement",
1626 DEFINE_PRIVATE_STRING_TABLE_LOOKUP_TO_STRING(creation_mode_verb
, CreationMode
);
1628 static int create_directory_or_subvolume(const char *path
, mode_t mode
, bool subvol
, CreationMode
*creation
) {
1629 _cleanup_free_
char *bn
= NULL
;
1630 _cleanup_close_
int pfd
= -1;
1639 r
= path_extract_filename(path
, &bn
);
1641 return log_error_errno(r
, "Failed to extract filename from path '%s': %m", path
);
1643 pfd
= path_open_parent_safe(path
);
1648 r
= getenv_bool("SYSTEMD_TMPFILES_FORCE_SUBVOL");
1650 if (r
!= -ENXIO
) /* env var is unset */
1651 log_warning_errno(r
, "Cannot parse value of $SYSTEMD_TMPFILES_FORCE_SUBVOL, ignoring.");
1652 r
= btrfs_is_subvol(empty_to_root(arg_root
)) > 0;
1655 /* Don't create a subvolume unless the root directory is one, too. We do this under
1656 * the assumption that if the root directory is just a plain directory (i.e. very
1657 * light-weight), we shouldn't try to split it up into subvolumes (i.e. more
1658 * heavy-weight). Thus, chroot() environments and suchlike will get a full brtfs
1659 * subvolume set up below their tree only if they specifically set up a btrfs
1660 * subvolume for the root dir too. */
1664 RUN_WITH_UMASK((~mode
) & 0777)
1665 r
= btrfs_subvol_make_fd(pfd
, bn
);
1670 if (!subvol
|| r
== -ENOTTY
)
1671 RUN_WITH_UMASK(0000)
1672 r
= mkdirat_label(pfd
, bn
, mode
);
1677 if (!IN_SET(r
, -EEXIST
, -EROFS
))
1678 return log_error_errno(r
, "Failed to create directory or subvolume \"%s\": %m", path
);
1680 k
= is_dir_full(pfd
, bn
, /* follow= */ false);
1681 if (k
== -ENOENT
&& r
== -EROFS
)
1682 return log_error_errno(r
, "%s does not exist and cannot be created as the file system is read-only.", path
);
1684 return log_error_errno(k
, "Failed to check if %s exists: %m", path
);
1686 return log_warning_errno(SYNTHETIC_ERRNO(EEXIST
),
1687 "\"%s\" already exists and is not a directory.", path
);
1689 *creation
= CREATION_EXISTING
;
1691 *creation
= CREATION_NORMAL
;
1693 log_debug("%s directory \"%s\".", creation_mode_verb_to_string(*creation
), path
);
1695 r
= openat(pfd
, bn
, O_NOCTTY
|O_CLOEXEC
|O_DIRECTORY
);
1697 return log_error_errno(errno
, "Failed to open directory '%s': %m", bn
);
1702 static int create_directory(Item
*i
, const char *path
) {
1703 _cleanup_close_
int fd
= -1;
1706 assert(IN_SET(i
->type
, CREATE_DIRECTORY
, TRUNCATE_DIRECTORY
));
1708 fd
= create_directory_or_subvolume(path
, i
->mode
, false, NULL
);
1714 return fd_set_perms(i
, fd
, path
, NULL
);
1717 static int create_subvolume(Item
*i
, const char *path
) {
1718 _cleanup_close_
int fd
= -1;
1719 CreationMode creation
;
1723 assert(IN_SET(i
->type
, CREATE_SUBVOLUME
, CREATE_SUBVOLUME_NEW_QUOTA
, CREATE_SUBVOLUME_INHERIT_QUOTA
));
1725 fd
= create_directory_or_subvolume(path
, i
->mode
, true, &creation
);
1731 if (creation
== CREATION_NORMAL
&&
1732 IN_SET(i
->type
, CREATE_SUBVOLUME_NEW_QUOTA
, CREATE_SUBVOLUME_INHERIT_QUOTA
)) {
1733 r
= btrfs_subvol_auto_qgroup_fd(fd
, 0, i
->type
== CREATE_SUBVOLUME_NEW_QUOTA
);
1735 log_debug_errno(r
, "Couldn't adjust quota for subvolume \"%s\" (unsupported fs or dir not a subvolume): %m", i
->path
);
1736 else if (r
== -EROFS
)
1737 log_debug_errno(r
, "Couldn't adjust quota for subvolume \"%s\" (fs is read-only).", i
->path
);
1738 else if (r
== -ENOTCONN
)
1739 log_debug_errno(r
, "Couldn't adjust quota for subvolume \"%s\" (quota support is disabled).", i
->path
);
1741 q
= log_error_errno(r
, "Failed to adjust quota for subvolume \"%s\": %m", i
->path
);
1743 log_debug("Adjusted quota for subvolume \"%s\".", i
->path
);
1745 log_debug("Quota for subvolume \"%s\" already in place, no change made.", i
->path
);
1748 r
= fd_set_perms(i
, fd
, path
, NULL
);
1749 if (q
< 0) /* prefer the quota change error from above */
1755 static int empty_directory(Item
*i
, const char *path
) {
1759 assert(i
->type
== EMPTY_DIRECTORY
);
1761 r
= is_dir(path
, false);
1763 /* Option "e" operates only on existing objects. Do not
1764 * print errors about non-existent files or directories */
1765 log_debug("Skipping missing directory: %s", path
);
1769 return log_error_errno(r
, "is_dir() failed on path %s: %m", path
);
1771 log_warning("\"%s\" already exists and is not a directory.", path
);
1775 return path_set_perms(i
, path
);
1778 static int create_device(Item
*i
, mode_t file_type
) {
1779 _cleanup_close_
int dfd
= -1, fd
= -1;
1780 _cleanup_free_
char *bn
= NULL
;
1781 CreationMode creation
;
1785 assert(IN_SET(file_type
, S_IFBLK
, S_IFCHR
));
1787 r
= path_extract_filename(i
->path
, &bn
);
1789 return log_error_errno(r
, "Failed to extract filename from path '%s': %m", i
->path
);
1790 if (r
== O_DIRECTORY
)
1791 return log_error_errno(SYNTHETIC_ERRNO(EISDIR
), "Cannot open path '%s' for creating device node, is a directory.", i
->path
);
1793 /* Validate the path and use the returned directory fd for copying the target so we're sure that the
1794 * path can't be changed behind our back. */
1795 dfd
= path_open_parent_safe(i
->path
);
1799 RUN_WITH_UMASK(0000) {
1800 mac_selinux_create_file_prepare(i
->path
, file_type
);
1801 r
= RET_NERRNO(mknodat(dfd
, bn
, i
->mode
| file_type
, i
->major_minor
));
1802 mac_selinux_create_file_clear();
1810 "We lack permissions, possibly because of cgroup configuration; "
1811 "skipping creation of device node %s.", i
->path
);
1816 return log_error_errno(r
, "Failed to create device node %s: %m", i
->path
);
1818 if (fstatat(dfd
, bn
, &st
, 0) < 0)
1819 return log_error_errno(errno
, "stat(%s) failed: %m", i
->path
);
1821 if ((st
.st_mode
& S_IFMT
) != file_type
) {
1823 if (i
->append_or_force
) {
1825 RUN_WITH_UMASK(0000) {
1826 mac_selinux_create_file_prepare(i
->path
, file_type
);
1827 /* FIXME: need to introduce mknodat_atomic() */
1828 r
= mknod_atomic(i
->path
, i
->mode
| file_type
, i
->major_minor
);
1829 mac_selinux_create_file_clear();
1833 return log_error_errno(r
, "Failed to create device node \"%s\": %m", i
->path
);
1834 creation
= CREATION_FORCE
;
1836 log_warning("\"%s\" already exists is not a device node.", i
->path
);
1840 creation
= CREATION_EXISTING
;
1842 creation
= CREATION_NORMAL
;
1844 log_debug("%s %s device node \"%s\" %u:%u.",
1845 creation_mode_verb_to_string(creation
),
1846 i
->type
== CREATE_BLOCK_DEVICE
? "block" : "char",
1847 i
->path
, major(i
->mode
), minor(i
->mode
));
1849 fd
= openat(dfd
, bn
, O_NOFOLLOW
|O_CLOEXEC
|O_PATH
);
1851 return log_error_errno(errno
, "Failed to openat(%s): %m", i
->path
);
1853 return fd_set_perms(i
, fd
, i
->path
, NULL
);
1856 static int create_fifo(Item
*i
, const char *path
) {
1857 _cleanup_close_
int pfd
= -1, fd
= -1;
1858 _cleanup_free_
char *bn
= NULL
;
1859 CreationMode creation
;
1863 r
= path_extract_filename(i
->path
, &bn
);
1865 return log_error_errno(r
, "Failed to extract filename from path '%s': %m", path
);
1866 if (r
== O_DIRECTORY
)
1867 return log_error_errno(SYNTHETIC_ERRNO(EISDIR
), "Cannot open path '%s' for creating FIFO, is a directory.", path
);
1869 pfd
= path_open_parent_safe(path
);
1873 RUN_WITH_UMASK(0000) {
1874 mac_selinux_create_file_prepare(path
, S_IFIFO
);
1875 r
= RET_NERRNO(mkfifoat(pfd
, bn
, i
->mode
));
1876 mac_selinux_create_file_clear();
1881 return log_error_errno(r
, "Failed to create fifo %s: %m", path
);
1883 if (fstatat(pfd
, bn
, &st
, AT_SYMLINK_NOFOLLOW
) < 0)
1884 return log_error_errno(errno
, "stat(%s) failed: %m", path
);
1886 if (!S_ISFIFO(st
.st_mode
)) {
1888 if (i
->append_or_force
) {
1889 RUN_WITH_UMASK(0000) {
1890 mac_selinux_create_file_prepare(path
, S_IFIFO
);
1891 r
= mkfifoat_atomic(pfd
, bn
, i
->mode
);
1892 mac_selinux_create_file_clear();
1896 return log_error_errno(r
, "Failed to create fifo %s: %m", path
);
1897 creation
= CREATION_FORCE
;
1899 log_warning("\"%s\" already exists and is not a fifo.", path
);
1903 creation
= CREATION_EXISTING
;
1905 creation
= CREATION_NORMAL
;
1907 log_debug("%s fifo \"%s\".", creation_mode_verb_to_string(creation
), path
);
1909 fd
= openat(pfd
, bn
, O_NOFOLLOW
|O_CLOEXEC
|O_PATH
);
1911 return log_error_errno(errno
, "Failed to openat(%s): %m", path
);
1913 return fd_set_perms(i
, fd
, i
->path
, NULL
);
1916 typedef int (*action_t
)(Item
*i
, const char *path
);
1917 typedef int (*fdaction_t
)(Item
*i
, int fd
, const char *path
, const struct stat
*st
);
1919 static int item_do(Item
*i
, int fd
, const char *path
, fdaction_t action
) {
1927 if (fstat(fd
, &st
) < 0) {
1928 r
= log_error_errno(errno
, "fstat() on file failed: %m");
1932 /* This returns the first error we run into, but nevertheless
1934 r
= action(i
, fd
, path
, &st
);
1936 if (S_ISDIR(st
.st_mode
)) {
1937 _cleanup_closedir_
DIR *d
= NULL
;
1939 /* The passed 'fd' was opened with O_PATH. We need to convert it into a 'regular' fd before
1940 * reading the directory content. */
1941 d
= opendir(FORMAT_PROC_FD_PATH(fd
));
1943 log_error_errno(errno
, "Failed to opendir() '%s': %m", FORMAT_PROC_FD_PATH(fd
));
1949 FOREACH_DIRENT_ALL(de
, d
, q
= -errno
; goto finish
) {
1952 if (dot_or_dot_dot(de
->d_name
))
1955 de_fd
= openat(fd
, de
->d_name
, O_NOFOLLOW
|O_CLOEXEC
|O_PATH
);
1957 q
= log_error_errno(errno
, "Failed to open() file '%s': %m", de
->d_name
);
1959 _cleanup_free_
char *de_path
= NULL
;
1961 de_path
= path_join(path
, de
->d_name
);
1965 /* Pass ownership of dirent fd over */
1966 q
= item_do(i
, de_fd
, de_path
, action
);
1969 if (q
< 0 && r
== 0)
1978 static int glob_item(Item
*i
, action_t action
) {
1979 _cleanup_globfree_ glob_t g
= {
1980 .gl_opendir
= (void *(*)(const char *)) opendir_nomod
,
1984 k
= safe_glob(i
->path
, GLOB_NOSORT
|GLOB_BRACE
, &g
);
1985 if (k
< 0 && k
!= -ENOENT
)
1986 return log_error_errno(k
, "glob(%s) failed: %m", i
->path
);
1988 STRV_FOREACH(fn
, g
.gl_pathv
) {
1990 if (k
< 0 && r
== 0)
1997 static int glob_item_recursively(Item
*i
, fdaction_t action
) {
1998 _cleanup_globfree_ glob_t g
= {
1999 .gl_opendir
= (void *(*)(const char *)) opendir_nomod
,
2003 k
= safe_glob(i
->path
, GLOB_NOSORT
|GLOB_BRACE
, &g
);
2004 if (k
< 0 && k
!= -ENOENT
)
2005 return log_error_errno(k
, "glob(%s) failed: %m", i
->path
);
2007 STRV_FOREACH(fn
, g
.gl_pathv
) {
2008 _cleanup_close_
int fd
= -1;
2010 /* Make sure we won't trigger/follow file object (such as
2011 * device nodes, automounts, ...) pointed out by 'fn' with
2012 * O_PATH. Note, when O_PATH is used, flags other than
2013 * O_CLOEXEC, O_DIRECTORY, and O_NOFOLLOW are ignored. */
2015 fd
= open(*fn
, O_CLOEXEC
|O_NOFOLLOW
|O_PATH
);
2017 log_error_errno(errno
, "Opening '%s' failed: %m", *fn
);
2023 k
= item_do(i
, fd
, *fn
, action
);
2024 if (k
< 0 && r
== 0)
2027 /* we passed fd ownership to the previous call */
2034 static int rm_if_wrong_type_safe(
2037 const struct stat
*parent_st
, /* Only used if follow_links below is true. */
2040 _cleanup_free_
char *parent_name
= NULL
;
2041 bool follow_links
= !FLAGS_SET(flags
, AT_SYMLINK_NOFOLLOW
);
2046 assert((mode
& ~S_IFMT
) == 0);
2047 assert(!follow_links
|| parent_st
);
2048 assert((flags
& ~AT_SYMLINK_NOFOLLOW
) == 0);
2050 if (!filename_is_valid(name
))
2051 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "\"%s\" is not a valid filename.", name
);
2053 r
= fstatat_harder(parent_fd
, name
, &st
, flags
, REMOVE_CHMOD
| REMOVE_CHMOD_RESTORE
);
2055 (void) fd_get_path(parent_fd
, &parent_name
);
2056 return log_full_errno(r
== -ENOENT
? LOG_DEBUG
: LOG_ERR
, r
,
2057 "Failed to stat \"%s\" at \"%s\": %m", name
, strna(parent_name
));
2060 /* Fail before removing anything if this is an unsafe transition. */
2061 if (follow_links
&& unsafe_transition(parent_st
, &st
)) {
2062 (void) fd_get_path(parent_fd
, &parent_name
);
2063 return log_error_errno(SYNTHETIC_ERRNO(ENOLINK
),
2064 "Unsafe transition from \"%s\" to \"%s\".", parent_name
, name
);
2067 if ((st
.st_mode
& S_IFMT
) == mode
)
2070 (void) fd_get_path(parent_fd
, &parent_name
);
2071 log_notice("Wrong file type 0x%x; rm -rf \"%s/%s\"", st
.st_mode
& S_IFMT
, strna(parent_name
), name
);
2073 /* If the target of the symlink was the wrong type, the link needs to be removed instead of the
2074 * target, so make sure it is identified as a link and not a directory. */
2076 r
= fstatat_harder(parent_fd
, name
, &st
, AT_SYMLINK_NOFOLLOW
, REMOVE_CHMOD
| REMOVE_CHMOD_RESTORE
);
2078 return log_error_errno(r
, "Failed to stat \"%s\" at \"%s\": %m", name
, strna(parent_name
));
2081 /* Do not remove mount points. */
2082 r
= fd_is_mount_point(parent_fd
, name
, follow_links
? AT_SYMLINK_FOLLOW
: 0);
2084 (void) log_warning_errno(r
, "Failed to check if \"%s/%s\" is a mount point: %m; Continuing",
2085 strna(parent_name
), name
);
2087 return log_error_errno(SYNTHETIC_ERRNO(EBUSY
),
2088 "Not removing \"%s/%s\" because it is a mount point.", strna(parent_name
), name
);
2090 if ((st
.st_mode
& S_IFMT
) == S_IFDIR
) {
2091 _cleanup_close_
int child_fd
= -1;
2093 child_fd
= openat(parent_fd
, name
, O_NOCTTY
| O_CLOEXEC
| O_DIRECTORY
);
2095 return log_error_errno(errno
, "Failed to open \"%s\" at \"%s\": %m", name
, strna(parent_name
));
2097 r
= rm_rf_children(TAKE_FD(child_fd
), REMOVE_ROOT
|REMOVE_SUBVOLUME
|REMOVE_PHYSICAL
, &st
);
2099 return log_error_errno(r
, "Failed to remove contents of \"%s\" at \"%s\": %m", name
, strna(parent_name
));
2101 r
= unlinkat_harder(parent_fd
, name
, AT_REMOVEDIR
, REMOVE_CHMOD
| REMOVE_CHMOD_RESTORE
);
2103 r
= unlinkat_harder(parent_fd
, name
, 0, REMOVE_CHMOD
| REMOVE_CHMOD_RESTORE
);
2105 return log_error_errno(r
, "Failed to remove \"%s\" at \"%s\": %m", name
, strna(parent_name
));
2107 /* This is covered by the log_notice "Wrong file type..." It is logged earlier because it gives
2108 * context to other error messages that might follow. */
2112 /* If child_mode is non-zero, rm_if_wrong_type_safe will be executed for the last path component. */
2113 static int mkdir_parents_rm_if_wrong_type(mode_t child_mode
, const char *path
) {
2114 _cleanup_close_
int parent_fd
= -1;
2115 struct stat parent_st
;
2120 assert((child_mode
& ~S_IFMT
) == 0);
2122 path_len
= strlen(path
);
2125 /* rm_if_wrong_type_safe already logs errors. */
2126 return child_mode
!= 0 ? rm_if_wrong_type_safe(child_mode
, AT_FDCWD
, NULL
, path
, AT_SYMLINK_NOFOLLOW
) : 0;
2128 if (child_mode
!= 0 && endswith(path
, "/"))
2129 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
2130 "Trailing path separators are only allowed if child_mode is not set; got \"%s\"", path
);
2132 /* Get the parent_fd and stat. */
2133 parent_fd
= openat(AT_FDCWD
, path_is_absolute(path
) ? "/" : ".", O_NOCTTY
| O_CLOEXEC
| O_DIRECTORY
);
2135 return log_error_errno(errno
, "Failed to open root: %m");
2137 if (fstat(parent_fd
, &parent_st
) < 0)
2138 return log_error_errno(errno
, "Failed to stat root: %m");
2140 /* Check every parent directory in the path, except the last component */
2141 for (const char *e
= path
;;) {
2142 _cleanup_close_
int next_fd
= -1;
2143 char t
[path_len
+ 1];
2146 /* Find the start of the next path component. */
2147 s
= e
+ strspn(e
, "/");
2148 /* Find the end of the next path component. */
2149 e
= s
+ strcspn(s
, "/");
2151 /* Copy the path component to t so it can be a null terminated string. */
2152 *((char*) mempcpy(t
, s
, e
- s
)) = 0;
2154 /* Is this the last component? If so, then check the type */
2156 return child_mode
!= 0 ? rm_if_wrong_type_safe(child_mode
, parent_fd
, &parent_st
, t
, AT_SYMLINK_NOFOLLOW
) : 0;
2158 r
= rm_if_wrong_type_safe(S_IFDIR
, parent_fd
, &parent_st
, t
, 0);
2159 /* Remove dangling symlinks. */
2161 r
= rm_if_wrong_type_safe(S_IFDIR
, parent_fd
, &parent_st
, t
, AT_SYMLINK_NOFOLLOW
);
2163 RUN_WITH_UMASK(0000)
2164 r
= mkdirat_label(parent_fd
, t
, 0755);
2166 _cleanup_free_
char *parent_name
= NULL
;
2168 (void) fd_get_path(parent_fd
, &parent_name
);
2169 return log_error_errno(r
, "Failed to mkdir \"%s\" at \"%s\": %m", t
, strnull(parent_name
));
2172 /* rm_if_wrong_type_safe already logs errors. */
2175 next_fd
= RET_NERRNO(openat(parent_fd
, t
, O_NOCTTY
| O_CLOEXEC
| O_DIRECTORY
));
2177 _cleanup_free_
char *parent_name
= NULL
;
2179 (void) fd_get_path(parent_fd
, &parent_name
);
2180 return log_error_errno(next_fd
, "Failed to open \"%s\" at \"%s\": %m", t
, strnull(parent_name
));
2182 r
= RET_NERRNO(fstat(next_fd
, &parent_st
));
2184 _cleanup_free_
char *parent_name
= NULL
;
2186 (void) fd_get_path(parent_fd
, &parent_name
);
2187 return log_error_errno(r
, "Failed to stat \"%s\" at \"%s\": %m", t
, strnull(parent_name
));
2190 CLOSE_AND_REPLACE(parent_fd
, next_fd
);
2194 static int mkdir_parents_item(Item
*i
, mode_t child_mode
) {
2196 if (i
->try_replace
) {
2197 r
= mkdir_parents_rm_if_wrong_type(child_mode
, i
->path
);
2198 if (r
< 0 && r
!= -ENOENT
)
2201 RUN_WITH_UMASK(0000)
2202 (void) mkdir_parents_label(i
->path
, 0755);
2207 static int create_item(Item
*i
) {
2208 CreationMode creation
;
2213 log_debug("Running create action for entry %c %s", (char) i
->type
, i
->path
);
2218 case IGNORE_DIRECTORY_PATH
:
2220 case RECURSIVE_REMOVE_PATH
:
2225 r
= mkdir_parents_item(i
, S_IFREG
);
2229 if ((i
->type
== CREATE_FILE
&& i
->append_or_force
) || i
->type
== TRUNCATE_FILE
)
2230 r
= truncate_file(i
, i
->path
);
2232 r
= create_file(i
, i
->path
);
2239 r
= mkdir_parents_item(i
, 0);
2249 r
= glob_item(i
, write_one_file
);
2255 case CREATE_DIRECTORY
:
2256 case TRUNCATE_DIRECTORY
:
2257 r
= mkdir_parents_item(i
, S_IFDIR
);
2261 r
= create_directory(i
, i
->path
);
2266 case CREATE_SUBVOLUME
:
2267 case CREATE_SUBVOLUME_INHERIT_QUOTA
:
2268 case CREATE_SUBVOLUME_NEW_QUOTA
:
2269 r
= mkdir_parents_item(i
, S_IFDIR
);
2273 r
= create_subvolume(i
, i
->path
);
2278 case EMPTY_DIRECTORY
:
2279 r
= glob_item(i
, empty_directory
);
2285 r
= mkdir_parents_item(i
, S_IFIFO
);
2289 r
= create_fifo(i
, i
->path
);
2294 case CREATE_SYMLINK
: {
2295 r
= mkdir_parents_item(i
, S_IFLNK
);
2299 mac_selinux_create_file_prepare(i
->path
, S_IFLNK
);
2300 r
= RET_NERRNO(symlink(i
->argument
, i
->path
));
2301 mac_selinux_create_file_clear();
2304 _cleanup_free_
char *x
= NULL
;
2307 return log_error_errno(r
, "symlink(%s, %s) failed: %m", i
->argument
, i
->path
);
2309 r
= readlink_malloc(i
->path
, &x
);
2310 if (r
< 0 || !streq(i
->argument
, x
)) {
2312 if (i
->append_or_force
) {
2313 mac_selinux_create_file_prepare(i
->path
, S_IFLNK
);
2314 r
= symlink_atomic(i
->argument
, i
->path
);
2315 mac_selinux_create_file_clear();
2317 if (IN_SET(r
, -EISDIR
, -EEXIST
, -ENOTEMPTY
)) {
2318 r
= rm_rf(i
->path
, REMOVE_ROOT
|REMOVE_PHYSICAL
);
2320 return log_error_errno(r
, "rm -fr %s failed: %m", i
->path
);
2322 mac_selinux_create_file_prepare(i
->path
, S_IFLNK
);
2323 r
= RET_NERRNO(symlink(i
->argument
, i
->path
));
2324 mac_selinux_create_file_clear();
2327 return log_error_errno(r
, "symlink(%s, %s) failed: %m", i
->argument
, i
->path
);
2329 creation
= CREATION_FORCE
;
2331 log_debug("\"%s\" is not a symlink or does not point to the correct path.", i
->path
);
2335 creation
= CREATION_EXISTING
;
2338 creation
= CREATION_NORMAL
;
2339 log_debug("%s symlink \"%s\".", creation_mode_verb_to_string(creation
), i
->path
);
2343 case CREATE_BLOCK_DEVICE
:
2344 case CREATE_CHAR_DEVICE
:
2345 if (have_effective_cap(CAP_MKNOD
) == 0) {
2346 /* In a container we lack CAP_MKNOD. We shouldn't attempt to create the device node in that
2347 * case to avoid noise, and we don't support virtualized devices in containers anyway. */
2349 log_debug("We lack CAP_MKNOD, skipping creation of device node %s.", i
->path
);
2353 r
= mkdir_parents_item(i
, i
->type
== CREATE_BLOCK_DEVICE
? S_IFBLK
: S_IFCHR
);
2357 r
= create_device(i
, i
->type
== CREATE_BLOCK_DEVICE
? S_IFBLK
: S_IFCHR
);
2365 r
= glob_item(i
, path_set_perms
);
2370 case RECURSIVE_RELABEL_PATH
:
2371 r
= glob_item_recursively(i
, fd_set_perms
);
2377 r
= glob_item(i
, path_set_xattrs
);
2382 case RECURSIVE_SET_XATTR
:
2383 r
= glob_item_recursively(i
, fd_set_xattrs
);
2389 r
= glob_item(i
, path_set_acls
);
2394 case RECURSIVE_SET_ACL
:
2395 r
= glob_item_recursively(i
, fd_set_acls
);
2401 r
= glob_item(i
, path_set_attribute
);
2406 case RECURSIVE_SET_ATTRIBUTE
:
2407 r
= glob_item_recursively(i
, fd_set_attribute
);
2416 static int remove_item_instance(Item
*i
, const char *instance
) {
2424 if (remove(instance
) < 0 && errno
!= ENOENT
)
2425 return log_error_errno(errno
, "rm(%s): %m", instance
);
2429 case RECURSIVE_REMOVE_PATH
:
2430 /* FIXME: we probably should use dir_cleanup() here instead of rm_rf() so that 'x' is honoured. */
2431 log_debug("rm -rf \"%s\"", instance
);
2432 r
= rm_rf(instance
, REMOVE_ROOT
|REMOVE_SUBVOLUME
|REMOVE_PHYSICAL
);
2433 if (r
< 0 && r
!= -ENOENT
)
2434 return log_error_errno(r
, "rm_rf(%s): %m", instance
);
2439 assert_not_reached();
2445 static int remove_item(Item
*i
) {
2450 log_debug("Running remove action for entry %c %s", (char) i
->type
, i
->path
);
2454 case TRUNCATE_DIRECTORY
:
2455 /* FIXME: we probably should use dir_cleanup() here instead of rm_rf() so that 'x' is honoured. */
2456 log_debug("rm -rf \"%s\"", i
->path
);
2457 r
= rm_rf(i
->path
, REMOVE_PHYSICAL
);
2458 if (r
< 0 && r
!= -ENOENT
)
2459 return log_error_errno(r
, "rm_rf(%s): %m", i
->path
);
2464 case RECURSIVE_REMOVE_PATH
:
2465 return glob_item(i
, remove_item_instance
);
2472 static char *age_by_to_string(AgeBy ab
, bool is_dir
) {
2473 static const char ab_map
[] = { 'a', 'b', 'c', 'm' };
2477 ret
= new(char, ELEMENTSOF(ab_map
) + 1);
2481 for (size_t i
= 0; i
< ELEMENTSOF(ab_map
); i
++)
2482 if (FLAGS_SET(ab
, 1U << i
))
2483 ret
[j
++] = is_dir
? ascii_toupper(ab_map
[i
]) : ab_map
[i
];
2489 static int clean_item_instance(Item
*i
, const char* instance
) {
2490 _cleanup_closedir_
DIR *d
= NULL
;
2491 STRUCT_STATX_DEFINE(sx
);
2500 n
= now(CLOCK_REALTIME
);
2504 cutoff
= n
- i
->age
;
2506 d
= opendir_nomod(instance
);
2508 if (IN_SET(errno
, ENOENT
, ENOTDIR
)) {
2509 log_debug_errno(errno
, "Directory \"%s\": %m", instance
);
2513 return log_error_errno(errno
, "Failed to open directory %s: %m", instance
);
2516 r
= statx_fallback(dirfd(d
), "", AT_EMPTY_PATH
, STATX_MODE
|STATX_INO
|STATX_ATIME
|STATX_MTIME
, &sx
);
2518 return log_error_errno(r
, "statx(%s) failed: %m", instance
);
2520 if (FLAGS_SET(sx
.stx_attributes_mask
, STATX_ATTR_MOUNT_ROOT
))
2521 mountpoint
= FLAGS_SET(sx
.stx_attributes
, STATX_ATTR_MOUNT_ROOT
);
2525 if (fstatat(dirfd(d
), "..", &ps
, AT_SYMLINK_NOFOLLOW
) != 0)
2526 return log_error_errno(errno
, "stat(%s/..) failed: %m", i
->path
);
2529 sx
.stx_dev_major
!= major(ps
.st_dev
) ||
2530 sx
.stx_dev_minor
!= minor(ps
.st_dev
) ||
2531 sx
.stx_ino
!= ps
.st_ino
;
2534 if (DEBUG_LOGGING
) {
2535 _cleanup_free_
char *ab_f
= NULL
, *ab_d
= NULL
;
2537 ab_f
= age_by_to_string(i
->age_by_file
, false);
2541 ab_d
= age_by_to_string(i
->age_by_dir
, true);
2545 log_debug("Cleanup threshold for %s \"%s\" is %s; age-by: %s%s",
2546 mountpoint
? "mount point" : "directory",
2548 FORMAT_TIMESTAMP_STYLE(cutoff
, TIMESTAMP_US
),
2552 return dir_cleanup(i
, instance
, d
,
2553 load_statx_timestamp_nsec(&sx
.stx_atime
),
2554 load_statx_timestamp_nsec(&sx
.stx_mtime
),
2555 cutoff
* NSEC_PER_USEC
,
2556 sx
.stx_dev_major
, sx
.stx_dev_minor
, mountpoint
,
2557 MAX_DEPTH
, i
->keep_first_level
,
2558 i
->age_by_file
, i
->age_by_dir
);
2561 static int clean_item(Item
*i
) {
2564 log_debug("Running clean action for entry %c %s", (char) i
->type
, i
->path
);
2567 case CREATE_DIRECTORY
:
2568 case CREATE_SUBVOLUME
:
2569 case CREATE_SUBVOLUME_INHERIT_QUOTA
:
2570 case CREATE_SUBVOLUME_NEW_QUOTA
:
2571 case TRUNCATE_DIRECTORY
:
2574 clean_item_instance(i
, i
->path
);
2576 case EMPTY_DIRECTORY
:
2577 case IGNORE_DIRECTORY_PATH
:
2578 return glob_item(i
, clean_item_instance
);
2584 static int process_item(Item
*i
, OperationMask operation
) {
2586 _cleanup_free_
char *_path
= NULL
;
2592 todo
= operation
& ~i
->done
;
2593 if (todo
== 0) /* Everything already done? */
2596 i
->done
|= operation
;
2599 if (string_is_glob(path
)) {
2600 /* We can't easily check whether a glob matches any autofs path, so let's do the check only
2601 * for the non-glob part. */
2603 r
= glob_non_glob_prefix(path
, &_path
);
2604 if (r
< 0 && r
!= -ENOENT
)
2605 return log_debug_errno(r
, "Failed to deglob path: %m");
2610 r
= chase_symlinks(path
, arg_root
, CHASE_NO_AUTOFS
|CHASE_NONEXISTENT
|CHASE_WARN
, NULL
, NULL
);
2611 if (r
== -EREMOTE
) {
2612 log_notice_errno(r
, "Skipping %s", i
->path
); /* We log the configured path, to not confuse the user. */
2616 log_debug_errno(r
, "Failed to determine whether '%s' is below autofs, ignoring: %m", i
->path
);
2618 r
= FLAGS_SET(operation
, OPERATION_CREATE
) ? create_item(i
) : 0;
2619 /* Failure can only be tolerated for create */
2620 if (i
->allow_failure
)
2623 q
= FLAGS_SET(operation
, OPERATION_REMOVE
) ? remove_item(i
) : 0;
2624 p
= FLAGS_SET(operation
, OPERATION_CLEAN
) ? clean_item(i
) : 0;
2631 static int process_item_array(ItemArray
*array
, OperationMask operation
) {
2637 /* Create any parent first. */
2638 if (FLAGS_SET(operation
, OPERATION_CREATE
) && array
->parent
)
2639 r
= process_item_array(array
->parent
, operation
& OPERATION_CREATE
);
2641 /* Clean up all children first */
2642 if ((operation
& (OPERATION_REMOVE
|OPERATION_CLEAN
)) && !set_isempty(array
->children
)) {
2645 SET_FOREACH(c
, array
->children
) {
2648 k
= process_item_array(c
, operation
& (OPERATION_REMOVE
|OPERATION_CLEAN
));
2649 if (k
< 0 && r
== 0)
2654 for (n
= 0; n
< array
->n_items
; n
++) {
2657 k
= process_item(array
->items
+ n
, operation
);
2658 if (k
< 0 && r
== 0)
2665 static void item_free_contents(Item
*i
) {
2669 free(i
->binary_argument
);
2670 strv_free(i
->xattrs
);
2673 acl_free(i
->acl_access
);
2674 acl_free(i
->acl_default
);
2678 static ItemArray
* item_array_free(ItemArray
*a
) {
2684 for (n
= 0; n
< a
->n_items
; n
++)
2685 item_free_contents(a
->items
+ n
);
2687 set_free(a
->children
);
2692 static int item_compare(const Item
*a
, const Item
*b
) {
2693 /* Make sure that the ownership taking item is put first, so
2694 * that we first create the node, and then can adjust it */
2696 if (takes_ownership(a
->type
) && !takes_ownership(b
->type
))
2698 if (!takes_ownership(a
->type
) && takes_ownership(b
->type
))
2701 return CMP(a
->type
, b
->type
);
2704 static bool item_compatible(const Item
*a
, const Item
*b
) {
2707 assert(streq(a
->path
, b
->path
));
2709 if (takes_ownership(a
->type
) && takes_ownership(b
->type
))
2710 /* check if the items are the same */
2711 return memcmp_nn(item_binary_argument(a
), item_binary_argument_size(a
),
2712 item_binary_argument(b
), item_binary_argument_size(b
)) == 0 &&
2714 a
->uid_set
== b
->uid_set
&&
2717 a
->gid_set
== b
->gid_set
&&
2720 a
->mode_set
== b
->mode_set
&&
2721 a
->mode
== b
->mode
&&
2723 a
->age_set
== b
->age_set
&&
2726 a
->age_by_file
== b
->age_by_file
&&
2727 a
->age_by_dir
== b
->age_by_dir
&&
2729 a
->mask_perms
== b
->mask_perms
&&
2731 a
->keep_first_level
== b
->keep_first_level
&&
2733 a
->major_minor
== b
->major_minor
;
2738 static bool should_include_path(const char *path
) {
2739 STRV_FOREACH(prefix
, arg_exclude_prefixes
)
2740 if (path_startswith(path
, *prefix
)) {
2741 log_debug("Entry \"%s\" matches exclude prefix \"%s\", skipping.",
2746 STRV_FOREACH(prefix
, arg_include_prefixes
)
2747 if (path_startswith(path
, *prefix
)) {
2748 log_debug("Entry \"%s\" matches include prefix \"%s\".", path
, *prefix
);
2752 /* no matches, so we should include this path only if we have no allow list at all */
2753 if (strv_isempty(arg_include_prefixes
))
2756 log_debug("Entry \"%s\" does not match any include prefix, skipping.", path
);
2760 static int specifier_expansion_from_arg(const Specifier
*specifier_table
, Item
*i
) {
2770 case CREATE_SYMLINK
:
2774 _cleanup_free_
char *unescaped
= NULL
, *resolved
= NULL
;
2777 l
= cunescape(i
->argument
, 0, &unescaped
);
2779 return log_error_errno(l
, "Failed to unescape parameter to write: %s", i
->argument
);
2781 r
= specifier_printf(unescaped
, PATH_MAX
-1, specifier_table
, arg_root
, NULL
, &resolved
);
2785 return free_and_replace(i
->argument
, resolved
);
2788 case RECURSIVE_SET_XATTR
:
2789 STRV_FOREACH(xattr
, i
->xattrs
) {
2790 _cleanup_free_
char *resolved
= NULL
;
2792 r
= specifier_printf(*xattr
, SIZE_MAX
, specifier_table
, arg_root
, NULL
, &resolved
);
2796 free_and_replace(*xattr
, resolved
);
2805 static int patch_var_run(const char *fname
, unsigned line
, char **path
) {
2812 /* Optionally rewrites lines referencing /var/run/, to use /run/ instead. Why bother? tmpfiles merges lines in
2813 * some cases and detects conflicts in others. If files/directories are specified through two equivalent lines
2814 * this is problematic as neither case will be detected. Ideally we'd detect these cases by resolving symlinks
2815 * early, but that's precisely not what we can do here as this code very likely is running very early on, at a
2816 * time where the paths in question are not available yet, or even more importantly, our own tmpfiles rules
2817 * might create the paths that are intermediary to the listed paths. We can't really cover the generic case,
2818 * but the least we can do is cover the specific case of /var/run vs. /run, as /var/run is a legacy name for
2819 * /run only, and we explicitly document that and require that on systemd systems the former is a symlink to
2820 * the latter. Moreover files below this path are by far the primary usecase for tmpfiles.d/. */
2822 k
= path_startswith(*path
, "/var/run/");
2823 if (isempty(k
)) /* Don't complain about other paths than /var/run, and not about /var/run itself either. */
2826 n
= path_join("/run", k
);
2830 /* Also log about this briefly. We do so at LOG_NOTICE level, as we fixed up the situation automatically, hence
2831 * there's no immediate need for action by the user. However, in the interest of making things less confusing
2832 * to the user, let's still inform the user that these snippets should really be updated. */
2833 log_syntax(NULL
, LOG_NOTICE
, fname
, line
, 0,
2834 "Line references path below legacy directory /var/run/, updating %s → %s; please update the tmpfiles.d/ drop-in file accordingly.",
2837 free_and_replace(*path
, n
);
2842 static int find_uid(const char *user
, uid_t
*ret_uid
, Hashmap
**cache
) {
2848 /* First: parse as numeric UID string */
2849 r
= parse_uid(user
, ret_uid
);
2853 /* Second: pass to NSS if we are running "online" */
2855 return get_user_creds(&user
, ret_uid
, NULL
, NULL
, NULL
, 0);
2857 /* Third, synthesize "root" unconditionally */
2858 if (streq(user
, "root")) {
2863 /* Fourth: use fgetpwent() to read /etc/passwd directly, if we are "offline" */
2864 return name_to_uid_offline(arg_root
, user
, ret_uid
, cache
);
2867 static int find_gid(const char *group
, gid_t
*ret_gid
, Hashmap
**cache
) {
2873 /* First: parse as numeric GID string */
2874 r
= parse_gid(group
, ret_gid
);
2878 /* Second: pass to NSS if we are running "online" */
2880 return get_group_creds(&group
, ret_gid
, 0);
2882 /* Third, synthesize "root" unconditionally */
2883 if (streq(group
, "root")) {
2888 /* Fourth: use fgetgrent() to read /etc/group directly, if we are "offline" */
2889 return name_to_gid_offline(arg_root
, group
, ret_gid
, cache
);
2892 static int parse_age_by_from_arg(const char *age_by_str
, Item
*item
) {
2893 AgeBy ab_f
= 0, ab_d
= 0;
2895 static const struct {
2898 } age_by_types
[] = {
2899 { 'a', AGE_BY_ATIME
},
2900 { 'b', AGE_BY_BTIME
},
2901 { 'c', AGE_BY_CTIME
},
2902 { 'm', AGE_BY_MTIME
},
2908 if (isempty(age_by_str
))
2911 for (const char *s
= age_by_str
; *s
!= 0; s
++) {
2914 /* Ignore whitespace. */
2915 if (strchr(WHITESPACE
, *s
))
2918 for (i
= 0; i
< ELEMENTSOF(age_by_types
); i
++) {
2919 /* Check lower-case for files, upper-case for directories. */
2920 if (*s
== age_by_types
[i
].age_by_chr
) {
2921 ab_f
|= age_by_types
[i
].age_by_flag
;
2923 } else if (*s
== ascii_toupper(age_by_types
[i
].age_by_chr
)) {
2924 ab_d
|= age_by_types
[i
].age_by_flag
;
2929 /* Invalid character. */
2930 if (i
>= ELEMENTSOF(age_by_types
))
2935 if (ab_f
== 0 && ab_d
== 0)
2938 item
->age_by_file
= ab_f
> 0 ? ab_f
: AGE_BY_DEFAULT_FILE
;
2939 item
->age_by_dir
= ab_d
> 0 ? ab_d
: AGE_BY_DEFAULT_DIR
;
2944 static bool is_duplicated_item(ItemArray
*existing
, const Item
*i
) {
2949 for (size_t n
= 0; n
< existing
->n_items
; n
++) {
2950 const Item
*e
= existing
->items
+ n
;
2952 if (item_compatible(e
, i
))
2955 /* Only multiple 'w+' lines for the same path are allowed. */
2956 if (e
->type
!= WRITE_FILE
|| !e
->append_or_force
||
2957 i
->type
!= WRITE_FILE
|| !i
->append_or_force
)
2964 static int parse_line(
2968 bool *invalid_config
,
2969 Hashmap
**uid_cache
,
2970 Hashmap
**gid_cache
) {
2972 _cleanup_free_
char *action
= NULL
, *mode
= NULL
, *user
= NULL
, *group
= NULL
, *age
= NULL
, *path
= NULL
;
2973 _cleanup_(item_free_contents
) Item i
= {
2974 /* The "age-by" argument considers all file timestamp types by default. */
2975 .age_by_file
= AGE_BY_DEFAULT_FILE
,
2976 .age_by_dir
= AGE_BY_DEFAULT_DIR
,
2978 ItemArray
*existing
;
2981 bool append_or_force
= false, boot
= false, allow_failure
= false, try_replace
= false, unbase64
= false;
2987 const Specifier specifier_table
[] = {
2988 { 'a', specifier_architecture
, NULL
},
2989 { 'b', specifier_boot_id
, NULL
},
2990 { 'B', specifier_os_build_id
, NULL
},
2991 { 'H', specifier_hostname
, NULL
},
2992 { 'l', specifier_short_hostname
, NULL
},
2993 { 'm', specifier_machine_id_safe
, NULL
},
2994 { 'o', specifier_os_id
, NULL
},
2995 { 'v', specifier_kernel_release
, NULL
},
2996 { 'w', specifier_os_version_id
, NULL
},
2997 { 'W', specifier_os_variant_id
, NULL
},
2999 { 'h', specifier_user_home
, NULL
},
3001 { 'C', specifier_directory
, UINT_TO_PTR(DIRECTORY_CACHE
) },
3002 { 'L', specifier_directory
, UINT_TO_PTR(DIRECTORY_LOGS
) },
3003 { 'S', specifier_directory
, UINT_TO_PTR(DIRECTORY_STATE
) },
3004 { 't', specifier_directory
, UINT_TO_PTR(DIRECTORY_RUNTIME
) },
3006 COMMON_CREDS_SPECIFIERS(arg_user
? LOOKUP_SCOPE_USER
: LOOKUP_SCOPE_SYSTEM
),
3007 COMMON_TMP_SPECIFIERS
,
3011 r
= extract_many_words(
3023 if (IN_SET(r
, -EINVAL
, -EBADSLT
))
3024 /* invalid quoting and such or an unknown specifier */
3025 *invalid_config
= true;
3026 return log_syntax(NULL
, LOG_ERR
, fname
, line
, r
, "Failed to parse line: %m");
3028 *invalid_config
= true;
3029 return log_syntax(NULL
, LOG_ERR
, fname
, line
, SYNTHETIC_ERRNO(EBADMSG
), "Syntax error.");
3032 if (!empty_or_dash(buffer
)) {
3033 i
.argument
= strdup(buffer
);
3038 if (isempty(action
)) {
3039 *invalid_config
= true;
3040 return log_syntax(NULL
, LOG_ERR
, fname
, line
, SYNTHETIC_ERRNO(EBADMSG
), "Command too short '%s'.", action
);
3043 for (pos
= 1; action
[pos
]; pos
++) {
3044 if (action
[pos
] == '!' && !boot
)
3046 else if (action
[pos
] == '+' && !append_or_force
)
3047 append_or_force
= true;
3048 else if (action
[pos
] == '-' && !allow_failure
)
3049 allow_failure
= true;
3050 else if (action
[pos
] == '=' && !try_replace
)
3052 else if (action
[pos
] == '~' && !unbase64
)
3055 *invalid_config
= true;
3056 return log_syntax(NULL
, LOG_ERR
, fname
, line
, SYNTHETIC_ERRNO(EBADMSG
), "Unknown modifiers in command '%s'", action
);
3060 if (boot
&& !arg_boot
) {
3061 log_syntax(NULL
, LOG_DEBUG
, fname
, line
, 0, "Ignoring entry %s \"%s\" because --boot is not specified.", action
, path
);
3066 i
.append_or_force
= append_or_force
;
3067 i
.allow_failure
= allow_failure
;
3068 i
.try_replace
= try_replace
;
3070 r
= specifier_printf(path
, PATH_MAX
-1, specifier_table
, arg_root
, NULL
, &i
.path
);
3072 return log_unresolvable_specifier(fname
, line
);
3074 if (IN_SET(r
, -EINVAL
, -EBADSLT
))
3075 *invalid_config
= true;
3076 return log_syntax(NULL
, LOG_ERR
, fname
, line
, r
, "Failed to replace specifiers in '%s': %m", path
);
3079 r
= patch_var_run(fname
, line
, &i
.path
);
3085 case CREATE_DIRECTORY
:
3086 case CREATE_SUBVOLUME
:
3087 case CREATE_SUBVOLUME_INHERIT_QUOTA
:
3088 case CREATE_SUBVOLUME_NEW_QUOTA
:
3089 case EMPTY_DIRECTORY
:
3090 case TRUNCATE_DIRECTORY
:
3093 case IGNORE_DIRECTORY_PATH
:
3095 case RECURSIVE_REMOVE_PATH
:
3098 case RECURSIVE_RELABEL_PATH
:
3100 log_syntax(NULL
, LOG_WARNING
, fname
, line
, 0, "%c lines don't take argument fields, ignoring.", i
.type
);
3108 case CREATE_SYMLINK
:
3110 *invalid_config
= true;
3111 return log_syntax(NULL
, LOG_ERR
, fname
, line
, SYNTHETIC_ERRNO(EBADMSG
), "base64 decoding not supported for symlink targets.");
3115 i
.argument
= path_join("/usr/share/factory", i
.path
);
3123 *invalid_config
= true;
3124 return log_syntax(NULL
, LOG_ERR
, fname
, line
, SYNTHETIC_ERRNO(EBADMSG
), "Write file requires argument.");
3130 *invalid_config
= true;
3131 return log_syntax(NULL
, LOG_ERR
, fname
, line
, SYNTHETIC_ERRNO(EBADMSG
), "base64 decoding not supported for copy sources.");
3135 i
.argument
= path_join("/usr/share/factory", i
.path
);
3138 } else if (!path_is_absolute(i
.argument
)) {
3139 *invalid_config
= true;
3140 return log_syntax(NULL
, LOG_ERR
, fname
, line
, SYNTHETIC_ERRNO(EBADMSG
), "Source path '%s' is not absolute.", i
.argument
);
3144 if (!empty_or_root(arg_root
)) {
3147 p
= path_join(arg_root
, i
.argument
);
3150 free_and_replace(i
.argument
, p
);
3153 path_simplify(i
.argument
);
3156 case CREATE_CHAR_DEVICE
:
3157 case CREATE_BLOCK_DEVICE
:
3159 *invalid_config
= true;
3160 return log_syntax(NULL
, LOG_ERR
, fname
, line
, SYNTHETIC_ERRNO(EBADMSG
), "base64 decoding not supported for device node creation.");
3164 *invalid_config
= true;
3165 return log_syntax(NULL
, LOG_ERR
, fname
, line
, SYNTHETIC_ERRNO(EBADMSG
), "Device file requires argument.");
3168 r
= parse_devnum(i
.argument
, &i
.major_minor
);
3170 *invalid_config
= true;
3171 return log_syntax(NULL
, LOG_ERR
, fname
, line
, r
, "Can't parse device file major/minor '%s'.", i
.argument
);
3177 case RECURSIVE_SET_XATTR
:
3179 *invalid_config
= true;
3180 return log_syntax(NULL
, LOG_ERR
, fname
, line
, SYNTHETIC_ERRNO(EBADMSG
), "base64 decoding not supported for extended attributes.");
3183 *invalid_config
= true;
3184 return log_syntax(NULL
, LOG_ERR
, fname
, line
, SYNTHETIC_ERRNO(EBADMSG
),
3185 "Set extended attribute requires argument.");
3187 r
= parse_xattrs_from_arg(&i
);
3193 case RECURSIVE_SET_ACL
:
3195 *invalid_config
= true;
3196 return log_syntax(NULL
, LOG_ERR
, fname
, line
, SYNTHETIC_ERRNO(EBADMSG
), "base64 decoding not supported for ACLs.");
3199 *invalid_config
= true;
3200 return log_syntax(NULL
, LOG_ERR
, fname
, line
, SYNTHETIC_ERRNO(EBADMSG
),
3201 "Set ACLs requires argument.");
3203 r
= parse_acls_from_arg(&i
);
3209 case RECURSIVE_SET_ATTRIBUTE
:
3211 *invalid_config
= true;
3212 return log_syntax(NULL
, LOG_ERR
, fname
, line
, SYNTHETIC_ERRNO(EBADMSG
), "base64 decoding not supported for file attributes.");
3215 *invalid_config
= true;
3216 return log_syntax(NULL
, LOG_ERR
, fname
, line
, SYNTHETIC_ERRNO(EBADMSG
),
3217 "Set file attribute requires argument.");
3219 r
= parse_attribute_from_arg(&i
);
3220 if (IN_SET(r
, -EINVAL
, -EBADSLT
))
3221 *invalid_config
= true;
3227 *invalid_config
= true;
3228 return log_syntax(NULL
, LOG_ERR
, fname
, line
, SYNTHETIC_ERRNO(EBADMSG
),
3229 "Unknown command type '%c'.", (char) i
.type
);
3232 if (!path_is_absolute(i
.path
)) {
3233 *invalid_config
= true;
3234 return log_syntax(NULL
, LOG_ERR
, fname
, line
, SYNTHETIC_ERRNO(EBADMSG
),
3235 "Path '%s' not absolute.", i
.path
);
3238 path_simplify(i
.path
);
3240 if (!should_include_path(i
.path
))
3245 r
= unbase64mem(i
.argument
, SIZE_MAX
, &i
.binary_argument
, &i
.binary_argument_size
);
3247 return log_syntax(NULL
, LOG_ERR
, fname
, line
, r
, "Failed to base64 decode specified argument '%s': %m", i
.argument
);
3250 r
= specifier_expansion_from_arg(specifier_table
, &i
);
3252 return log_unresolvable_specifier(fname
, line
);
3254 if (IN_SET(r
, -EINVAL
, -EBADSLT
))
3255 *invalid_config
= true;
3256 return log_syntax(NULL
, LOG_ERR
, fname
, line
, r
, "Failed to substitute specifiers in argument: %m");
3260 if (!empty_or_root(arg_root
)) {
3263 p
= path_join(arg_root
, i
.path
);
3266 free_and_replace(i
.path
, p
);
3269 if (!empty_or_dash(user
)) {
3270 r
= find_uid(user
, &i
.uid
, uid_cache
);
3272 *invalid_config
= true;
3273 return log_syntax(NULL
, LOG_ERR
, fname
, line
, r
, "Failed to resolve user '%s': %m", user
);
3279 if (!empty_or_dash(group
)) {
3280 r
= find_gid(group
, &i
.gid
, gid_cache
);
3282 *invalid_config
= true;
3283 return log_syntax(NULL
, LOG_ERR
, fname
, line
, r
, "Failed to resolve group '%s'.", group
);
3289 if (!empty_or_dash(mode
)) {
3290 const char *mm
= mode
;
3294 i
.mask_perms
= true;
3298 r
= parse_mode(mm
, &m
);
3300 *invalid_config
= true;
3301 return log_syntax(NULL
, LOG_ERR
, fname
, line
, r
, "Invalid mode '%s'.", mode
);
3307 i
.mode
= IN_SET(i
.type
, CREATE_DIRECTORY
, TRUNCATE_DIRECTORY
, CREATE_SUBVOLUME
, CREATE_SUBVOLUME_INHERIT_QUOTA
, CREATE_SUBVOLUME_NEW_QUOTA
) ? 0755 : 0644;
3309 if (!empty_or_dash(age
)) {
3310 const char *a
= age
;
3311 _cleanup_free_
char *seconds
= NULL
, *age_by
= NULL
;
3314 i
.keep_first_level
= true;
3318 /* Format: "age-by:age"; where age-by is "[abcmABCM]+". */
3319 r
= split_pair(a
, ":", &age_by
, &seconds
);
3322 if (r
< 0 && r
!= -EINVAL
)
3323 return log_error_errno(r
, "Failed to parse age-by for '%s': %m", age
);
3325 /* We found a ":", parse the "age-by" part. */
3326 r
= parse_age_by_from_arg(age_by
, &i
);
3330 *invalid_config
= true;
3331 return log_syntax(NULL
, LOG_ERR
, fname
, line
, r
, "Invalid age-by '%s'.", age_by
);
3334 /* For parsing the "age" part, after the ":". */
3338 r
= parse_sec(a
, &i
.age
);
3340 *invalid_config
= true;
3341 return log_syntax(NULL
, LOG_ERR
, fname
, line
, r
, "Invalid age '%s'.", a
);
3347 h
= needs_glob(i
.type
) ? globs
: items
;
3349 existing
= ordered_hashmap_get(h
, i
.path
);
3351 if (is_duplicated_item(existing
, &i
)) {
3352 log_syntax(NULL
, LOG_NOTICE
, fname
, line
, 0,
3353 "Duplicate line for path \"%s\", ignoring.", i
.path
);
3357 existing
= new0(ItemArray
, 1);
3361 r
= ordered_hashmap_put(h
, i
.path
, existing
);
3368 if (!GREEDY_REALLOC(existing
->items
, existing
->n_items
+ 1))
3371 existing
->items
[existing
->n_items
++] = i
;
3372 i
= (struct Item
) {};
3374 /* Sort item array, to enforce stable ordering of application */
3375 typesafe_qsort(existing
->items
, existing
->n_items
, item_compare
);
3380 static int cat_config(char **config_dirs
, char **args
) {
3381 _cleanup_strv_free_
char **files
= NULL
;
3384 r
= conf_files_list_with_replacement(arg_root
, config_dirs
, arg_replace
, &files
, NULL
);
3388 return cat_files(NULL
, files
, 0);
3391 static int exclude_default_prefixes(void) {
3394 /* Provide an easy way to exclude virtual/memory file systems from what we do here. Useful in
3395 * combination with --root= where we probably don't want to apply stuff to these dirs as they are
3396 * likely over-mounted if the root directory is actually used, and it wouldbe less than ideal to have
3397 * all kinds of files created/adjusted underneath these mount points. */
3399 r
= strv_extend_strv(
3400 &arg_exclude_prefixes
,
3412 static int help(void) {
3413 _cleanup_free_
char *link
= NULL
;
3416 r
= terminal_urlify_man("systemd-tmpfiles", "8", &link
);
3420 printf("%s [OPTIONS...] [CONFIGURATION FILE...]\n"
3421 "\n%sCreates, deletes and cleans up volatile and temporary files and directories.%s\n\n"
3422 " -h --help Show this help\n"
3423 " --user Execute user configuration\n"
3424 " --version Show package version\n"
3425 " --cat-config Show configuration files\n"
3426 " --create Create marked files/directories\n"
3427 " --clean Clean up marked directories\n"
3428 " --remove Remove marked files/directories\n"
3429 " --boot Execute actions only safe at boot\n"
3430 " --prefix=PATH Only apply rules with the specified prefix\n"
3431 " --exclude-prefix=PATH Ignore rules with the specified prefix\n"
3432 " -E Ignore rules prefixed with /dev, /proc, /run, /sys\n"
3433 " --root=PATH Operate on an alternate filesystem root\n"
3434 " --image=PATH Operate on disk image as filesystem root\n"
3435 " --replace=PATH Treat arguments as replacement for PATH\n"
3436 " --no-pager Do not pipe output into a pager\n"
3437 "\nSee the %s for details.\n",
3438 program_invocation_short_name
,
3446 static int parse_argv(int argc
, char *argv
[]) {
3449 ARG_VERSION
= 0x100,
3464 static const struct option options
[] = {
3465 { "help", no_argument
, NULL
, 'h' },
3466 { "user", no_argument
, NULL
, ARG_USER
},
3467 { "version", no_argument
, NULL
, ARG_VERSION
},
3468 { "cat-config", no_argument
, NULL
, ARG_CAT_CONFIG
},
3469 { "create", no_argument
, NULL
, ARG_CREATE
},
3470 { "clean", no_argument
, NULL
, ARG_CLEAN
},
3471 { "remove", no_argument
, NULL
, ARG_REMOVE
},
3472 { "boot", no_argument
, NULL
, ARG_BOOT
},
3473 { "prefix", required_argument
, NULL
, ARG_PREFIX
},
3474 { "exclude-prefix", required_argument
, NULL
, ARG_EXCLUDE_PREFIX
},
3475 { "root", required_argument
, NULL
, ARG_ROOT
},
3476 { "image", required_argument
, NULL
, ARG_IMAGE
},
3477 { "replace", required_argument
, NULL
, ARG_REPLACE
},
3478 { "no-pager", no_argument
, NULL
, ARG_NO_PAGER
},
3487 while ((c
= getopt_long(argc
, argv
, "hE", options
, NULL
)) >= 0)
3497 case ARG_CAT_CONFIG
:
3498 arg_cat_config
= true;
3506 arg_operation
|= OPERATION_CREATE
;
3510 arg_operation
|= OPERATION_CLEAN
;
3514 arg_operation
|= OPERATION_REMOVE
;
3522 if (strv_push(&arg_include_prefixes
, optarg
) < 0)
3526 case ARG_EXCLUDE_PREFIX
:
3527 if (strv_push(&arg_exclude_prefixes
, optarg
) < 0)
3532 r
= parse_path_argument(optarg
, /* suppress_root= */ false, &arg_root
);
3539 return log_error_errno(SYNTHETIC_ERRNO(EOPNOTSUPP
),
3540 "This systemd-tmpfiles version is compiled without support for --image=.");
3542 r
= parse_path_argument(optarg
, /* suppress_root= */ false, &arg_image
);
3546 /* Imply -E here since it makes little sense to create files persistently in the /run mountpoint of a disk image */
3550 r
= exclude_default_prefixes();
3557 if (!path_is_absolute(optarg
) ||
3558 !endswith(optarg
, ".conf"))
3559 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
3560 "The argument to --replace= must an absolute path to a config file");
3562 arg_replace
= optarg
;
3566 arg_pager_flags
|= PAGER_DISABLE
;
3573 assert_not_reached();
3576 if (arg_operation
== 0 && !arg_cat_config
)
3577 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
3578 "You need to specify at least one of --clean, --create or --remove.");
3580 if (arg_replace
&& arg_cat_config
)
3581 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
3582 "Option --replace= is not supported with --cat-config");
3584 if (arg_replace
&& optind
>= argc
)
3585 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
3586 "When --replace= is given, some configuration items must be specified");
3588 if (arg_root
&& arg_user
)
3589 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
3590 "Combination of --user and --root= is not supported.");
3592 if (arg_image
&& arg_root
)
3593 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "Please specify either --root= or --image=, the combination of both is not supported.");
3598 static int read_config_file(
3602 bool *invalid_config
) {
3604 _cleanup_(hashmap_freep
) Hashmap
*uid_cache
= NULL
, *gid_cache
= NULL
;
3605 _cleanup_fclose_
FILE *_f
= NULL
;
3606 _cleanup_free_
char *pp
= NULL
;
3614 if (streq(fn
, "-")) {
3615 log_debug("Reading config from stdin%s", special_glyph(SPECIAL_GLYPH_ELLIPSIS
));
3619 r
= search_and_fopen(fn
, "re", arg_root
, (const char**) config_dirs
, &_f
, &pp
);
3621 if (ignore_enoent
&& r
== -ENOENT
) {
3622 log_debug_errno(r
, "Failed to open \"%s\", ignoring: %m", fn
);
3626 return log_error_errno(r
, "Failed to open '%s': %m", fn
);
3629 log_debug("Reading config file \"%s\"%s", pp
, special_glyph(SPECIAL_GLYPH_ELLIPSIS
));
3635 _cleanup_free_
char *line
= NULL
;
3636 bool invalid_line
= false;
3640 k
= read_line(f
, LONG_LINE_MAX
, &line
);
3642 return log_error_errno(k
, "Failed to read '%s': %m", fn
);
3649 if (IN_SET(*l
, 0, '#'))
3652 k
= parse_line(fn
, v
, l
, &invalid_line
, &uid_cache
, &gid_cache
);
3655 /* Allow reporting with a special code if the caller requested this */
3656 *invalid_config
= true;
3658 /* The first error becomes our return value */
3663 /* we have to determine age parameter for each entry of type X */
3664 ORDERED_HASHMAP_FOREACH(ia
, globs
)
3665 for (size_t ni
= 0; ni
< ia
->n_items
; ni
++) {
3667 Item
*i
= ia
->items
+ ni
, *candidate_item
= NULL
;
3669 if (i
->type
!= IGNORE_DIRECTORY_PATH
)
3672 ORDERED_HASHMAP_FOREACH(ja
, items
)
3673 for (size_t nj
= 0; nj
< ja
->n_items
; nj
++) {
3674 Item
*j
= ja
->items
+ nj
;
3676 if (!IN_SET(j
->type
, CREATE_DIRECTORY
,
3679 CREATE_SUBVOLUME_INHERIT_QUOTA
,
3680 CREATE_SUBVOLUME_NEW_QUOTA
))
3683 if (path_equal(j
->path
, i
->path
)) {
3689 ? (path_startswith(j
->path
, candidate_item
->path
) && fnmatch(i
->path
, j
->path
, FNM_PATHNAME
| FNM_PERIOD
) == 0)
3690 : path_startswith(i
->path
, j
->path
) != NULL
)
3694 if (candidate_item
&& candidate_item
->age_set
) {
3695 i
->age
= candidate_item
->age
;
3701 log_error_errno(errno
, "Failed to read from file %s: %m", fn
);
3709 static int parse_arguments(char **config_dirs
, char **args
, bool *invalid_config
) {
3712 STRV_FOREACH(arg
, args
) {
3713 r
= read_config_file(config_dirs
, *arg
, false, invalid_config
);
3721 static int read_config_files(char **config_dirs
, char **args
, bool *invalid_config
) {
3722 _cleanup_strv_free_
char **files
= NULL
;
3723 _cleanup_free_
char *p
= NULL
;
3726 r
= conf_files_list_with_replacement(arg_root
, config_dirs
, arg_replace
, &files
, &p
);
3730 STRV_FOREACH(f
, files
)
3731 if (p
&& path_equal(*f
, p
)) {
3732 log_debug("Parsing arguments at position \"%s\"%s", *f
, special_glyph(SPECIAL_GLYPH_ELLIPSIS
));
3734 r
= parse_arguments(config_dirs
, args
, invalid_config
);
3738 /* Just warn, ignore result otherwise.
3739 * read_config_file() has some debug output, so no need to print anything. */
3740 (void) read_config_file(config_dirs
, *f
, true, invalid_config
);
3745 static int read_credential_lines(bool *invalid_config
) {
3746 _cleanup_free_
char *j
= NULL
;
3750 r
= get_credentials_dir(&d
);
3754 return log_error_errno(r
, "Failed to get credentials directory: %m");
3756 j
= path_join(d
, "tmpfiles.extra");
3760 (void) read_config_file(/* config_dirs= */ NULL
, j
, /* ignore_enoent= */ true, invalid_config
);
3764 static int link_parent(ItemArray
*a
) {
3771 /* Finds the closest "parent" item array for the specified item array. Then registers the specified item array
3772 * as child of it, and fills the parent in, linking them both ways. This allows us to later create parents
3773 * before their children, and clean up/remove children before their parents. */
3775 if (a
->n_items
<= 0)
3778 path
= a
->items
[0].path
;
3779 prefix
= newa(char, strlen(path
) + 1);
3780 PATH_FOREACH_PREFIX(prefix
, path
) {
3783 j
= ordered_hashmap_get(items
, prefix
);
3785 j
= ordered_hashmap_get(globs
, prefix
);
3787 r
= set_ensure_put(&j
->children
, NULL
, a
);
3799 DEFINE_PRIVATE_HASH_OPS_WITH_VALUE_DESTRUCTOR(item_array_hash_ops
, char, string_hash_func
, string_compare_func
,
3800 ItemArray
, item_array_free
);
3802 static int run(int argc
, char *argv
[]) {
3804 _cleanup_(loop_device_unrefp
) LoopDevice
*loop_device
= NULL
;
3805 _cleanup_(decrypted_image_unrefp
) DecryptedImage
*decrypted_image
= NULL
;
3806 _cleanup_(umount_and_rmdir_and_freep
) char *unlink_dir
= NULL
;
3808 _cleanup_strv_free_
char **config_dirs
= NULL
;
3809 bool invalid_config
= false;
3812 PHASE_REMOVE_AND_CLEAN
,
3818 r
= parse_argv(argc
, argv
);
3824 /* We require /proc/ for a lot of our operations, i.e. for adjusting access modes, for anything
3825 * SELinux related, for recursive operation, for xattr, acl and chattr handling, for btrfs stuff and
3826 * a lot more. It's probably the majority of invocations where /proc/ is required. Since people
3827 * apparently invoke it without anyway and are surprised about the failures, let's catch this early
3828 * and output a nice and friendly warning. */
3829 if (proc_mounted() == 0)
3830 return log_error_errno(SYNTHETIC_ERRNO(ENOSYS
),
3831 "/proc/ is not mounted, but required for successful operation of systemd-tmpfiles. "
3832 "Please mount /proc/. Alternatively, consider using the --root= or --image= switches.");
3834 /* Descending down file system trees might take a lot of fds */
3835 (void) rlimit_nofile_bump(HIGH_RLIMIT_NOFILE
);
3838 r
= user_config_paths(&config_dirs
);
3840 return log_error_errno(r
, "Failed to initialize configuration directory list: %m");
3842 config_dirs
= strv_split_nulstr(CONF_PATHS_NULSTR("tmpfiles.d"));
3847 if (DEBUG_LOGGING
) {
3848 _cleanup_free_
char *t
= NULL
;
3850 STRV_FOREACH(i
, config_dirs
) {
3851 _cleanup_free_
char *j
= NULL
;
3853 j
= path_join(arg_root
, *i
);
3857 if (!strextend(&t
, "\n\t", j
))
3861 log_debug("Looking for configuration files in (higher priority first):%s", t
);
3864 if (arg_cat_config
) {
3865 pager_open(arg_pager_flags
);
3867 return cat_config(config_dirs
, argv
+ optind
);
3872 r
= mac_selinux_init();
3880 r
= mount_image_privately_interactively(
3882 DISSECT_IMAGE_GENERIC_ROOT
|
3883 DISSECT_IMAGE_REQUIRE_ROOT
|
3884 DISSECT_IMAGE_VALIDATE_OS
|
3885 DISSECT_IMAGE_RELAX_VAR_CHECK
|
3886 DISSECT_IMAGE_FSCK
|
3887 DISSECT_IMAGE_GROWFS
,
3894 arg_root
= strdup(unlink_dir
);
3902 items
= ordered_hashmap_new(&item_array_hash_ops
);
3903 globs
= ordered_hashmap_new(&item_array_hash_ops
);
3904 if (!items
|| !globs
)
3907 /* If command line arguments are specified along with --replace, read all
3908 * configuration files and insert the positional arguments at the specified
3909 * place. Otherwise, if command line arguments are specified, execute just
3910 * them, and finally, without --replace= or any positional arguments, just
3911 * read configuration and execute it.
3913 if (arg_replace
|| optind
>= argc
)
3914 r
= read_config_files(config_dirs
, argv
+ optind
, &invalid_config
);
3916 r
= parse_arguments(config_dirs
, argv
+ optind
, &invalid_config
);
3920 r
= read_credential_lines(&invalid_config
);
3924 /* Let's now link up all child/parent relationships */
3925 ORDERED_HASHMAP_FOREACH(a
, items
) {
3930 ORDERED_HASHMAP_FOREACH(a
, globs
) {
3936 /* If multiple operations are requested, let's first run the remove/clean operations, and only then the create
3937 * operations. i.e. that we first clean out the platform we then build on. */
3938 for (phase
= 0; phase
< _PHASE_MAX
; phase
++) {
3941 if (phase
== PHASE_REMOVE_AND_CLEAN
)
3942 op
= arg_operation
& (OPERATION_REMOVE
|OPERATION_CLEAN
);
3943 else if (phase
== PHASE_CREATE
)
3944 op
= arg_operation
& OPERATION_CREATE
;
3946 assert_not_reached();
3948 if (op
== 0) /* Nothing requested in this phase */
3951 /* The non-globbing ones usually create things, hence we apply them first */
3952 ORDERED_HASHMAP_FOREACH(a
, items
) {
3953 k
= process_item_array(a
, op
);
3954 if (k
< 0 && r
>= 0)
3958 /* The globbing ones usually alter things, hence we apply them second. */
3959 ORDERED_HASHMAP_FOREACH(a
, globs
) {
3960 k
= process_item_array(a
, op
);
3961 if (k
< 0 && r
>= 0)
3966 if (ERRNO_IS_RESOURCE(r
))
3971 return EX_CANTCREAT
;
3975 DEFINE_MAIN_FUNCTION_WITH_POSITIVE_FAILURE(run
);