1 /* SPDX-License-Identifier: LGPL-2.1+ */
17 #include <sys/xattr.h>
25 #include "alloc-util.h"
26 #include "btrfs-util.h"
27 #include "capability-util.h"
28 #include "chattr-util.h"
29 #include "conf-files.h"
32 #include "dirent-util.h"
36 #include "format-util.h"
38 #include "glob-util.h"
43 #include "main-func.h"
46 #include "mountpoint-util.h"
48 #include "parse-util.h"
49 #include "path-lookup.h"
50 #include "path-util.h"
51 #include "pretty-print.h"
52 #include "rlimit-util.h"
54 #include "selinux-util.h"
56 #include "sort-util.h"
57 #include "specifier.h"
58 #include "stat-util.h"
59 #include "stdio-util.h"
60 #include "string-table.h"
61 #include "string-util.h"
63 #include "umask-util.h"
64 #include "user-util.h"
66 /* This reads all files listed in /etc/tmpfiles.d/?*.conf and creates
67 * them in the file system. This is intended to be used to create
68 * properly owned directories beneath /tmp, /var/tmp, /run, which are
69 * volatile and hence need to be recreated on bootup. */
71 typedef enum OperationMask
{
72 OPERATION_CREATE
= 1 << 0,
73 OPERATION_REMOVE
= 1 << 1,
74 OPERATION_CLEAN
= 1 << 2,
77 typedef enum ItemType
{
78 /* These ones take file names */
81 CREATE_DIRECTORY
= 'd',
82 TRUNCATE_DIRECTORY
= 'D',
83 CREATE_SUBVOLUME
= 'v',
84 CREATE_SUBVOLUME_INHERIT_QUOTA
= 'q',
85 CREATE_SUBVOLUME_NEW_QUOTA
= 'Q',
88 CREATE_CHAR_DEVICE
= 'c',
89 CREATE_BLOCK_DEVICE
= 'b',
92 /* These ones take globs */
94 EMPTY_DIRECTORY
= 'e',
96 RECURSIVE_SET_XATTR
= 'T',
98 RECURSIVE_SET_ACL
= 'A',
100 RECURSIVE_SET_ATTRIBUTE
= 'H',
102 IGNORE_DIRECTORY_PATH
= 'X',
104 RECURSIVE_REMOVE_PATH
= 'R',
106 RECURSIVE_RELABEL_PATH
= 'Z',
107 ADJUST_MODE
= 'm', /* legacy, 'z' is identical to this */
110 typedef struct Item
{
126 unsigned attribute_value
;
127 unsigned attribute_mask
;
134 bool attribute_set
:1;
136 bool keep_first_level
:1;
140 bool allow_failure
:1;
145 typedef struct ItemArray
{
150 struct ItemArray
*parent
;
154 typedef enum DirectoryType
{
162 static bool arg_cat_config
= false;
163 static bool arg_user
= false;
164 static OperationMask arg_operation
= 0;
165 static bool arg_boot
= false;
166 static PagerFlags arg_pager_flags
= 0;
168 static char **arg_include_prefixes
= NULL
;
169 static char **arg_exclude_prefixes
= NULL
;
170 static char *arg_root
= NULL
;
171 static char *arg_replace
= NULL
;
173 #define MAX_DEPTH 256
175 static OrderedHashmap
*items
= NULL
, *globs
= NULL
;
176 static Set
*unix_sockets
= NULL
;
178 STATIC_DESTRUCTOR_REGISTER(items
, ordered_hashmap_freep
);
179 STATIC_DESTRUCTOR_REGISTER(globs
, ordered_hashmap_freep
);
180 STATIC_DESTRUCTOR_REGISTER(unix_sockets
, set_free_freep
);
181 STATIC_DESTRUCTOR_REGISTER(arg_include_prefixes
, freep
);
182 STATIC_DESTRUCTOR_REGISTER(arg_exclude_prefixes
, freep
);
183 STATIC_DESTRUCTOR_REGISTER(arg_root
, freep
);
185 static int specifier_machine_id_safe(char specifier
, const void *data
, const void *userdata
, char **ret
);
186 static int specifier_directory(char specifier
, const void *data
, const void *userdata
, char **ret
);
188 static const Specifier specifier_table
[] = {
189 { 'm', specifier_machine_id_safe
, NULL
},
190 { 'b', specifier_boot_id
, NULL
},
191 { 'H', specifier_host_name
, NULL
},
192 { 'v', specifier_kernel_release
, NULL
},
194 { 'g', specifier_group_name
, NULL
},
195 { 'G', specifier_group_id
, NULL
},
196 { 'U', specifier_user_id
, NULL
},
197 { 'u', specifier_user_name
, NULL
},
198 { 'h', specifier_user_home
, NULL
},
200 { 't', specifier_directory
, UINT_TO_PTR(DIRECTORY_RUNTIME
) },
201 { 'S', specifier_directory
, UINT_TO_PTR(DIRECTORY_STATE
) },
202 { 'C', specifier_directory
, UINT_TO_PTR(DIRECTORY_CACHE
) },
203 { 'L', specifier_directory
, UINT_TO_PTR(DIRECTORY_LOGS
) },
204 { 'T', specifier_tmp_dir
, NULL
},
205 { 'V', specifier_var_tmp_dir
, NULL
},
209 static int specifier_machine_id_safe(char specifier
, const void *data
, const void *userdata
, char **ret
) {
212 /* If /etc/machine_id is missing or empty (e.g. in a chroot environment)
213 * return a recognizable error so that the caller can skip the rule
216 r
= specifier_machine_id(specifier
, data
, userdata
, ret
);
217 if (IN_SET(r
, -ENOENT
, -ENOMEDIUM
))
223 static int specifier_directory(char specifier
, const void *data
, const void *userdata
, char **ret
) {
229 static const struct table_entry paths_system
[] = {
230 [DIRECTORY_RUNTIME
] = { SD_PATH_SYSTEM_RUNTIME
},
231 [DIRECTORY_STATE
] = { SD_PATH_SYSTEM_STATE_PRIVATE
},
232 [DIRECTORY_CACHE
] = { SD_PATH_SYSTEM_STATE_CACHE
},
233 [DIRECTORY_LOGS
] = { SD_PATH_SYSTEM_STATE_LOGS
},
236 static const struct table_entry paths_user
[] = {
237 [DIRECTORY_RUNTIME
] = { SD_PATH_USER_RUNTIME
},
238 [DIRECTORY_STATE
] = { SD_PATH_USER_CONFIGURATION
},
239 [DIRECTORY_CACHE
] = { SD_PATH_USER_STATE_CACHE
},
240 [DIRECTORY_LOGS
] = { SD_PATH_USER_CONFIGURATION
, "log" },
244 const struct table_entry
*paths
;
246 assert_cc(ELEMENTSOF(paths_system
) == ELEMENTSOF(paths_user
));
247 paths
= arg_user
? paths_user
: paths_system
;
249 i
= PTR_TO_UINT(data
);
250 assert(i
< ELEMENTSOF(paths_system
));
252 return sd_path_home(paths
[i
].type
, paths
[i
].suffix
, ret
);
255 static int log_unresolvable_specifier(const char *filename
, unsigned line
) {
256 static bool notified
= false;
258 /* In system mode, this is called when /etc is not fully initialized (e.g.
259 * in a chroot environment) where some specifiers are unresolvable. In user
260 * mode, this is called when some variables are not defined. These cases are
261 * not considered as an error so log at LOG_NOTICE only for the first time
262 * and then downgrade this to LOG_DEBUG for the rest. */
264 log_full(notified
? LOG_DEBUG
: LOG_NOTICE
,
265 "[%s:%u] Failed to resolve specifier: %s, skipping",
267 arg_user
? "Required $XDG_... variable not defined" : "uninitialized /etc detected");
270 log_notice("All rules containing unresolvable specifiers will be skipped.");
276 static int user_config_paths(char*** ret
) {
277 _cleanup_strv_free_
char **config_dirs
= NULL
, **data_dirs
= NULL
;
278 _cleanup_free_
char *persistent_config
= NULL
, *runtime_config
= NULL
, *data_home
= NULL
;
279 _cleanup_strv_free_
char **res
= NULL
;
282 r
= xdg_user_dirs(&config_dirs
, &data_dirs
);
286 r
= xdg_user_config_dir(&persistent_config
, "/user-tmpfiles.d");
287 if (r
< 0 && r
!= -ENXIO
)
290 r
= xdg_user_runtime_dir(&runtime_config
, "/user-tmpfiles.d");
291 if (r
< 0 && r
!= -ENXIO
)
294 r
= xdg_user_data_dir(&data_home
, "/user-tmpfiles.d");
295 if (r
< 0 && r
!= -ENXIO
)
298 r
= strv_extend_strv_concat(&res
, config_dirs
, "/user-tmpfiles.d");
302 r
= strv_extend(&res
, persistent_config
);
306 r
= strv_extend(&res
, runtime_config
);
310 r
= strv_extend(&res
, data_home
);
314 r
= strv_extend_strv_concat(&res
, data_dirs
, "/user-tmpfiles.d");
318 r
= path_strv_make_absolute_cwd(res
);
322 *ret
= TAKE_PTR(res
);
326 static bool needs_glob(ItemType t
) {
330 IGNORE_DIRECTORY_PATH
,
332 RECURSIVE_REMOVE_PATH
,
336 RECURSIVE_RELABEL_PATH
,
342 RECURSIVE_SET_ATTRIBUTE
);
345 static bool takes_ownership(ItemType t
) {
353 CREATE_SUBVOLUME_INHERIT_QUOTA
,
354 CREATE_SUBVOLUME_NEW_QUOTA
,
362 IGNORE_DIRECTORY_PATH
,
364 RECURSIVE_REMOVE_PATH
);
367 static struct Item
* find_glob(OrderedHashmap
*h
, const char *match
) {
371 ORDERED_HASHMAP_FOREACH(j
, h
, i
) {
374 for (n
= 0; n
< j
->n_items
; n
++) {
375 Item
*item
= j
->items
+ n
;
377 if (fnmatch(item
->path
, match
, FNM_PATHNAME
|FNM_PERIOD
) == 0)
385 static int load_unix_sockets(void) {
386 _cleanup_set_free_free_ Set
*sockets
= NULL
;
387 _cleanup_fclose_
FILE *f
= NULL
;
393 /* We maintain a cache of the sockets we found in /proc/net/unix to speed things up a little. */
395 sockets
= set_new(&path_hash_ops
);
399 f
= fopen("/proc/net/unix", "re");
401 return log_full_errno(errno
== ENOENT
? LOG_DEBUG
: LOG_WARNING
, errno
,
402 "Failed to open /proc/net/unix, ignoring: %m");
405 r
= read_line(f
, LONG_LINE_MAX
, NULL
);
407 return log_warning_errno(r
, "Failed to skip /proc/net/unix header line: %m");
409 return log_warning_errno(SYNTHETIC_ERRNO(EIO
), "Premature end of file reading /proc/net/unix.");
412 _cleanup_free_
char *line
= NULL
, *s
= NULL
;
415 r
= read_line(f
, LONG_LINE_MAX
, &line
);
417 return log_warning_errno(r
, "Failed to read /proc/net/unix line, ignoring: %m");
418 if (r
== 0) /* EOF */
421 p
= strchr(line
, ':');
429 p
+= strspn(p
, WHITESPACE
);
430 p
+= strcspn(p
, WHITESPACE
); /* skip one more word */
431 p
+= strspn(p
, WHITESPACE
);
440 path_simplify(s
, false);
442 r
= set_consume(sockets
, s
);
446 return log_warning_errno(r
, "Failed to add AF_UNIX socket to set, ignoring: %m");
451 unix_sockets
= TAKE_PTR(sockets
);
455 static bool unix_socket_alive(const char *fn
) {
458 if (load_unix_sockets() < 0)
459 return true; /* We don't know, so assume yes */
461 return !!set_get(unix_sockets
, (char*) fn
);
464 static int dir_is_mount_point(DIR *d
, const char *subdir
) {
466 int mount_id_parent
, mount_id
;
469 r_p
= name_to_handle_at_loop(dirfd(d
), ".", NULL
, &mount_id_parent
, 0);
473 r
= name_to_handle_at_loop(dirfd(d
), subdir
, NULL
, &mount_id
, 0);
477 /* got no handle; make no assumptions, return error */
478 if (r_p
< 0 && r
< 0)
481 /* got both handles; if they differ, it is a mount point */
482 if (r_p
>= 0 && r
>= 0)
483 return mount_id_parent
!= mount_id
;
485 /* got only one handle; assume different mount points if one
486 * of both queries was not supported by the filesystem */
487 if (IN_SET(r_p
, -ENOSYS
, -EOPNOTSUPP
) || IN_SET(r
, -ENOSYS
, -EOPNOTSUPP
))
496 static DIR* xopendirat_nomod(int dirfd
, const char *path
) {
499 dir
= xopendirat(dirfd
, path
, O_NOFOLLOW
|O_NOATIME
);
503 log_debug_errno(errno
, "Cannot open %sdirectory \"%s\": %m", dirfd
== AT_FDCWD
? "" : "sub", path
);
507 dir
= xopendirat(dirfd
, path
, O_NOFOLLOW
);
509 log_debug_errno(errno
, "Cannot open %sdirectory \"%s\": %m", dirfd
== AT_FDCWD
? "" : "sub", path
);
514 static DIR* opendir_nomod(const char *path
) {
515 return xopendirat_nomod(AT_FDCWD
, path
);
518 static int dir_cleanup(
522 const struct stat
*ds
,
527 bool keep_this_level
) {
530 bool deleted
= false;
533 FOREACH_DIRENT_ALL(dent
, d
, break) {
536 _cleanup_free_
char *sub_path
= NULL
;
538 if (dot_or_dot_dot(dent
->d_name
))
541 if (fstatat(dirfd(d
), dent
->d_name
, &s
, AT_SYMLINK_NOFOLLOW
) < 0) {
545 /* FUSE, NFS mounts, SELinux might return EACCES */
546 r
= log_full_errno(errno
== EACCES
? LOG_DEBUG
: LOG_ERR
, errno
,
547 "stat(%s/%s) failed: %m", p
, dent
->d_name
);
551 /* Stay on the same filesystem */
552 if (s
.st_dev
!= rootdev
) {
553 log_debug("Ignoring \"%s/%s\": different filesystem.", p
, dent
->d_name
);
557 /* Try to detect bind mounts of the same filesystem instance; they
558 * do not differ in device major/minors. This type of query is not
559 * supported on all kernels or filesystem types though. */
560 if (S_ISDIR(s
.st_mode
) && dir_is_mount_point(d
, dent
->d_name
) > 0) {
561 log_debug("Ignoring \"%s/%s\": different mount of the same filesystem.",
566 sub_path
= strjoin(p
, "/", dent
->d_name
);
572 /* Is there an item configured for this path? */
573 if (ordered_hashmap_get(items
, sub_path
)) {
574 log_debug("Ignoring \"%s\": a separate entry exists.", sub_path
);
578 if (find_glob(globs
, sub_path
)) {
579 log_debug("Ignoring \"%s\": a separate glob exists.", sub_path
);
583 if (S_ISDIR(s
.st_mode
)) {
584 _cleanup_closedir_
DIR *sub_dir
= NULL
;
587 streq(dent
->d_name
, "lost+found") &&
589 log_debug("Ignoring directory \"%s\".", sub_path
);
594 log_warning("Reached max depth on \"%s\".", sub_path
);
598 sub_dir
= xopendirat_nomod(dirfd(d
), dent
->d_name
);
601 r
= log_warning_errno(errno
, "Opening directory \"%s\" failed, ignoring: %m", sub_path
);
606 if (flock(dirfd(sub_dir
), LOCK_EX
|LOCK_NB
) < 0) {
607 log_debug_errno(errno
, "Couldn't acquire shared BSD lock on directory \"%s\", skipping: %m", p
);
611 q
= dir_cleanup(i
, sub_path
, sub_dir
, &s
, cutoff
, rootdev
, false, maxdepth
-1, false);
616 /* Note: if you are wondering why we don't support the sticky bit for excluding
617 * directories from cleaning like we do it for other file system objects: well, the
618 * sticky bit already has a meaning for directories, so we don't want to overload
621 if (keep_this_level
) {
622 log_debug("Keeping directory \"%s\".", sub_path
);
626 /* Ignore ctime, we change it when deleting */
627 age
= timespec_load(&s
.st_mtim
);
629 char a
[FORMAT_TIMESTAMP_MAX
];
630 /* Follows spelling in stat(1). */
631 log_debug("Directory \"%s\": modify time %s is too new.",
633 format_timestamp_us(a
, sizeof(a
), age
));
637 age
= timespec_load(&s
.st_atim
);
639 char a
[FORMAT_TIMESTAMP_MAX
];
640 log_debug("Directory \"%s\": access time %s is too new.",
642 format_timestamp_us(a
, sizeof(a
), age
));
646 log_debug("Removing directory \"%s\".", sub_path
);
647 if (unlinkat(dirfd(d
), dent
->d_name
, AT_REMOVEDIR
) < 0)
648 if (!IN_SET(errno
, ENOENT
, ENOTEMPTY
))
649 r
= log_warning_errno(errno
, "Failed to remove directory \"%s\", ignoring: %m", sub_path
);
652 /* Skip files for which the sticky bit is set. These are semantics we define, and are
653 * unknown elsewhere. See XDG_RUNTIME_DIR specification for details. */
654 if (s
.st_mode
& S_ISVTX
) {
655 log_debug("Skipping \"%s\": sticky bit set.", sub_path
);
659 if (mountpoint
&& S_ISREG(s
.st_mode
))
660 if (s
.st_uid
== 0 && STR_IN_SET(dent
->d_name
,
664 log_debug("Skipping \"%s\".", sub_path
);
668 /* Ignore sockets that are listed in /proc/net/unix */
669 if (S_ISSOCK(s
.st_mode
) && unix_socket_alive(sub_path
)) {
670 log_debug("Skipping \"%s\": live socket.", sub_path
);
674 /* Ignore device nodes */
675 if (S_ISCHR(s
.st_mode
) || S_ISBLK(s
.st_mode
)) {
676 log_debug("Skipping \"%s\": a device.", sub_path
);
680 /* Keep files on this level around if this is requested */
681 if (keep_this_level
) {
682 log_debug("Keeping \"%s\".", sub_path
);
686 age
= timespec_load(&s
.st_mtim
);
688 char a
[FORMAT_TIMESTAMP_MAX
];
689 /* Follows spelling in stat(1). */
690 log_debug("File \"%s\": modify time %s is too new.",
692 format_timestamp_us(a
, sizeof(a
), age
));
696 age
= timespec_load(&s
.st_atim
);
698 char a
[FORMAT_TIMESTAMP_MAX
];
699 log_debug("File \"%s\": access time %s is too new.",
701 format_timestamp_us(a
, sizeof(a
), age
));
705 age
= timespec_load(&s
.st_ctim
);
707 char a
[FORMAT_TIMESTAMP_MAX
];
708 log_debug("File \"%s\": change time %s is too new.",
710 format_timestamp_us(a
, sizeof(a
), age
));
714 log_debug("Removing \"%s\".", sub_path
);
715 if (unlinkat(dirfd(d
), dent
->d_name
, 0) < 0)
717 r
= log_warning_errno(errno
, "Failed to remove \"%s\", ignoring: %m", sub_path
);
725 char a
[FORMAT_TIMESTAMP_MAX
], b
[FORMAT_TIMESTAMP_MAX
];
728 age1
= timespec_load(&ds
->st_atim
);
729 age2
= timespec_load(&ds
->st_mtim
);
731 log_debug("Restoring access and modification time on \"%s\": %s, %s",
733 format_timestamp_us(a
, sizeof(a
), age1
),
734 format_timestamp_us(b
, sizeof(b
), age2
));
736 /* Restore original directory timestamps */
737 if (futimens(dirfd(d
), (struct timespec
[]) {
740 log_warning_errno(errno
, "Failed to revert timestamps of '%s', ignoring: %m", p
);
746 static bool dangerous_hardlinks(void) {
747 _cleanup_free_
char *value
= NULL
;
748 static int cached
= -1;
751 /* Check whether the fs.protected_hardlinks sysctl is on. If we can't determine it we assume its off, as that's
752 * what the upstream default is. */
757 r
= read_one_line_file("/proc/sys/fs/protected_hardlinks", &value
);
759 log_debug_errno(r
, "Failed to read fs.protected_hardlinks sysctl: %m");
763 r
= parse_boolean(value
);
765 log_debug_errno(r
, "Failed to parse fs.protected_hardlinks sysctl: %m");
773 static bool hardlink_vulnerable(const struct stat
*st
) {
776 return !S_ISDIR(st
->st_mode
) && st
->st_nlink
> 1 && dangerous_hardlinks();
779 static mode_t
process_mask_perms(mode_t mode
, mode_t current
) {
781 if ((current
& 0111) == 0)
783 if ((current
& 0222) == 0)
785 if ((current
& 0444) == 0)
787 if (!S_ISDIR(current
))
788 mode
&= ~07000; /* remove sticky/sgid/suid bit, unless directory */
793 static int fd_set_perms(Item
*i
, int fd
, const char *path
, const struct stat
*st
) {
802 if (!i
->mode_set
&& !i
->uid_set
&& !i
->gid_set
)
806 if (fstat(fd
, &stbuf
) < 0)
807 return log_error_errno(errno
, "fstat(%s) failed: %m", path
);
811 if (hardlink_vulnerable(st
))
812 return log_error_errno(SYNTHETIC_ERRNO(EPERM
),
813 "Refusing to set permissions on hardlinked file %s while the fs.protected_hardlinks sysctl is turned off.",
816 /* Do we need a chown()? */
818 (i
->uid_set
&& i
->uid
!= st
->st_uid
) ||
819 (i
->gid_set
&& i
->gid
!= st
->st_gid
);
821 /* Calculate the mode to apply */
822 new_mode
= i
->mode_set
? (i
->mask_perms
?
823 process_mask_perms(i
->mode
, st
->st_mode
) :
825 (st
->st_mode
& 07777);
827 if (i
->mode_set
&& do_chown
) {
828 /* Before we issue the chmod() let's reduce the access mode to the common bits of the old and
829 * the new mode. That way there's no time window where the file exists under the old owner
830 * with more than the old access modes — and not under the new owner with more than the new
831 * access modes either. */
833 if (S_ISLNK(st
->st_mode
))
834 log_debug("Skipping temporary mode fix for symlink %s.", path
);
836 mode_t m
= new_mode
& st
->st_mode
; /* Mask new mode by old mode */
838 if (((m
^ st
->st_mode
) & 07777) == 0)
839 log_debug("\"%s\" matches temporary mode %o already.", path
, m
);
841 log_debug("Temporarily changing \"%s\" to mode %o.", path
, m
);
842 if (fchmod_opath(fd
, m
) < 0)
843 return log_error_errno(errno
, "fchmod() of %s failed: %m", path
);
849 log_debug("Changing \"%s\" to owner "UID_FMT
":"GID_FMT
,
851 i
->uid_set
? i
->uid
: UID_INVALID
,
852 i
->gid_set
? i
->gid
: GID_INVALID
);
856 i
->uid_set
? i
->uid
: UID_INVALID
,
857 i
->gid_set
? i
->gid
: GID_INVALID
,
859 return log_error_errno(errno
, "fchownat() of %s failed: %m", path
);
862 /* Now, apply the final mode. We do this in two cases: when the user set a mode explicitly, or after a
863 * chown(), since chown()'s mangle the access mode in regards to sgid/suid in some conditions. */
864 if (i
->mode_set
|| do_chown
) {
865 if (S_ISLNK(st
->st_mode
))
866 log_debug("Skipping mode fix for symlink %s.", path
);
868 /* Check if the chmod() is unnecessary. Note that if we did a chown() before we always
869 * chmod() here again, since it might have mangled the bits. */
870 if (!do_chown
&& ((new_mode
^ st
->st_mode
) & 07777) == 0)
871 log_debug("\"%s\" matches mode %o already.", path
, new_mode
);
873 log_debug("Changing \"%s\" to mode %o.", path
, new_mode
);
874 if (fchmod_opath(fd
, new_mode
) < 0)
875 return log_error_errno(errno
, "fchmod() of %s failed: %m", path
);
881 return label_fix(path
, 0);
884 static int path_open_parent_safe(const char *path
) {
885 _cleanup_free_
char *dn
= NULL
;
888 if (path_equal(path
, "/") || !path_is_normalized(path
))
889 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
890 "Failed to open parent of '%s': invalid path.",
893 dn
= dirname_malloc(path
);
897 fd
= chase_symlinks(dn
, arg_root
, CHASE_OPEN
|CHASE_SAFE
|CHASE_WARN
, NULL
);
898 if (fd
< 0 && fd
!= -ENOLINK
)
899 return log_error_errno(fd
, "Failed to validate path %s: %m", path
);
904 static int path_open_safe(const char *path
) {
907 /* path_open_safe() returns a file descriptor opened with O_PATH after
908 * verifying that the path doesn't contain unsafe transitions, except
909 * for its final component as the function does not follow symlink. */
913 if (!path_is_normalized(path
))
914 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
915 "Failed to open invalid path '%s'.",
918 fd
= chase_symlinks(path
, arg_root
, CHASE_OPEN
|CHASE_SAFE
|CHASE_WARN
|CHASE_NOFOLLOW
, NULL
);
919 if (fd
< 0 && fd
!= -ENOLINK
)
920 return log_error_errno(fd
, "Failed to validate path %s: %m", path
);
925 static int path_set_perms(Item
*i
, const char *path
) {
926 _cleanup_close_
int fd
= -1;
931 fd
= path_open_safe(path
);
935 return fd_set_perms(i
, fd
, path
, NULL
);
938 static int parse_xattrs_from_arg(Item
*i
) {
948 _cleanup_free_
char *name
= NULL
, *value
= NULL
, *xattr
= NULL
;
950 r
= extract_first_word(&p
, &xattr
, NULL
, EXTRACT_QUOTES
|EXTRACT_CUNESCAPE
);
952 log_warning_errno(r
, "Failed to parse extended attribute '%s', ignoring: %m", p
);
956 r
= split_pair(xattr
, "=", &name
, &value
);
958 log_warning_errno(r
, "Failed to parse extended attribute, ignoring: %s", xattr
);
962 if (isempty(name
) || isempty(value
)) {
963 log_warning("Malformed extended attribute found, ignoring: %s", xattr
);
967 if (strv_push_pair(&i
->xattrs
, name
, value
) < 0)
976 static int fd_set_xattrs(Item
*i
, int fd
, const char *path
, const struct stat
*st
) {
977 char procfs_path
[STRLEN("/proc/self/fd/") + DECIMAL_STR_MAX(int)];
978 char **name
, **value
;
984 xsprintf(procfs_path
, "/proc/self/fd/%i", fd
);
986 STRV_FOREACH_PAIR(name
, value
, i
->xattrs
) {
987 log_debug("Setting extended attribute '%s=%s' on %s.", *name
, *value
, path
);
988 if (setxattr(procfs_path
, *name
, *value
, strlen(*value
), 0) < 0)
989 return log_error_errno(errno
, "Setting extended attribute %s=%s on %s failed: %m",
990 *name
, *value
, path
);
995 static int path_set_xattrs(Item
*i
, const char *path
) {
996 _cleanup_close_
int fd
= -1;
1001 fd
= path_open_safe(path
);
1005 return fd_set_xattrs(i
, fd
, path
, NULL
);
1008 static int parse_acls_from_arg(Item
*item
) {
1014 /* If force (= modify) is set, we will not modify the acl
1015 * afterwards, so the mask can be added now if necessary. */
1017 r
= parse_acl(item
->argument
, &item
->acl_access
, &item
->acl_default
, !item
->force
);
1019 log_warning_errno(r
, "Failed to parse ACL \"%s\": %m. Ignoring", item
->argument
);
1021 log_warning_errno(SYNTHETIC_ERRNO(ENOSYS
), "ACLs are not supported. Ignoring");
1028 static int path_set_acl(const char *path
, const char *pretty
, acl_type_t type
, acl_t acl
, bool modify
) {
1029 _cleanup_(acl_free_charpp
) char *t
= NULL
;
1030 _cleanup_(acl_freep
) acl_t dup
= NULL
;
1033 /* Returns 0 for success, positive error if already warned,
1034 * negative error otherwise. */
1037 r
= acls_for_file(path
, type
, acl
, &dup
);
1041 r
= calc_acl_mask_if_needed(&dup
);
1049 /* the mask was already added earlier if needed */
1052 r
= add_base_acls_if_needed(&dup
, path
);
1056 t
= acl_to_any_text(dup
, NULL
, ',', TEXT_ABBREVIATE
);
1057 log_debug("Setting %s ACL %s on %s.",
1058 type
== ACL_TYPE_ACCESS
? "access" : "default",
1061 r
= acl_set_file(path
, type
, dup
);
1063 /* Return positive to indicate we already warned */
1064 return -log_error_errno(errno
,
1065 "Setting %s ACL \"%s\" on %s failed: %m",
1066 type
== ACL_TYPE_ACCESS
? "access" : "default",
1073 static int fd_set_acls(Item
*item
, int fd
, const char *path
, const struct stat
*st
) {
1076 char procfs_path
[STRLEN("/proc/self/fd/") + DECIMAL_STR_MAX(int)];
1084 if (fstat(fd
, &stbuf
) < 0)
1085 return log_error_errno(errno
, "fstat(%s) failed: %m", path
);
1089 if (hardlink_vulnerable(st
))
1090 return log_error_errno(SYNTHETIC_ERRNO(EPERM
),
1091 "Refusing to set ACLs on hardlinked file %s while the fs.protected_hardlinks sysctl is turned off.",
1094 if (S_ISLNK(st
->st_mode
)) {
1095 log_debug("Skipping ACL fix for symlink %s.", path
);
1099 xsprintf(procfs_path
, "/proc/self/fd/%i", fd
);
1101 if (item
->acl_access
)
1102 r
= path_set_acl(procfs_path
, path
, ACL_TYPE_ACCESS
, item
->acl_access
, item
->force
);
1104 /* set only default acls to folders */
1105 if (r
== 0 && item
->acl_default
&& S_ISDIR(st
->st_mode
))
1106 r
= path_set_acl(procfs_path
, path
, ACL_TYPE_DEFAULT
, item
->acl_default
, item
->force
);
1109 return -r
; /* already warned */
1110 if (r
== -EOPNOTSUPP
) {
1111 log_debug_errno(r
, "ACLs not supported by file system at %s", path
);
1115 return log_error_errno(r
, "ACL operation on \"%s\" failed: %m", path
);
1120 static int path_set_acls(Item
*item
, const char *path
) {
1123 _cleanup_close_
int fd
= -1;
1128 fd
= path_open_safe(path
);
1132 r
= fd_set_acls(item
, fd
, path
, NULL
);
1137 static int parse_attribute_from_arg(Item
*item
) {
1139 static const struct {
1143 { 'A', FS_NOATIME_FL
}, /* do not update atime */
1144 { 'S', FS_SYNC_FL
}, /* Synchronous updates */
1145 { 'D', FS_DIRSYNC_FL
}, /* dirsync behaviour (directories only) */
1146 { 'a', FS_APPEND_FL
}, /* writes to file may only append */
1147 { 'c', FS_COMPR_FL
}, /* Compress file */
1148 { 'd', FS_NODUMP_FL
}, /* do not dump file */
1149 { 'e', FS_EXTENT_FL
}, /* Extents */
1150 { 'i', FS_IMMUTABLE_FL
}, /* Immutable file */
1151 { 'j', FS_JOURNAL_DATA_FL
}, /* Reserved for ext3 */
1152 { 's', FS_SECRM_FL
}, /* Secure deletion */
1153 { 'u', FS_UNRM_FL
}, /* Undelete */
1154 { 't', FS_NOTAIL_FL
}, /* file tail should not be merged */
1155 { 'T', FS_TOPDIR_FL
}, /* Top of directory hierarchies */
1156 { 'C', FS_NOCOW_FL
}, /* Do not cow file */
1157 { 'P', FS_PROJINHERIT_FL
}, /* Inherit the quota project ID */
1166 unsigned value
= 0, mask
= 0;
1176 } else if (*p
== '-') {
1179 } else if (*p
== '=') {
1185 if (isempty(p
) && mode
!= MODE_SET
)
1186 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
1187 "Setting file attribute on '%s' needs an attribute specification.",
1190 for (; p
&& *p
; p
++) {
1193 for (i
= 0; i
< ELEMENTSOF(attributes
); i
++)
1194 if (*p
== attributes
[i
].character
)
1197 if (i
>= ELEMENTSOF(attributes
))
1198 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
1199 "Unknown file attribute '%c' on '%s'.",
1202 v
= attributes
[i
].value
;
1204 SET_FLAG(value
, v
, IN_SET(mode
, MODE_ADD
, MODE_SET
));
1209 if (mode
== MODE_SET
)
1210 mask
|= CHATTR_ALL_FL
;
1214 item
->attribute_mask
= mask
;
1215 item
->attribute_value
= value
;
1216 item
->attribute_set
= true;
1221 static int fd_set_attribute(Item
*item
, int fd
, const char *path
, const struct stat
*st
) {
1222 _cleanup_close_
int procfs_fd
= -1;
1231 if (!item
->attribute_set
|| item
->attribute_mask
== 0)
1235 if (fstat(fd
, &stbuf
) < 0)
1236 return log_error_errno(errno
, "fstat(%s) failed: %m", path
);
1240 /* Issuing the file attribute ioctls on device nodes is not
1241 * safe, as that will be delivered to the drivers, not the
1242 * file system containing the device node. */
1243 if (!S_ISREG(st
->st_mode
) && !S_ISDIR(st
->st_mode
))
1244 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
1245 "Setting file flags is only supported on regular files and directories, cannot set on '%s'.",
1248 f
= item
->attribute_value
& item
->attribute_mask
;
1250 /* Mask away directory-specific flags */
1251 if (!S_ISDIR(st
->st_mode
))
1252 f
&= ~FS_DIRSYNC_FL
;
1254 procfs_fd
= fd_reopen(fd
, O_RDONLY
|O_CLOEXEC
|O_NOATIME
);
1256 return log_error_errno(procfs_fd
, "Failed to re-open '%s': %m", path
);
1258 r
= chattr_fd(procfs_fd
, f
, item
->attribute_mask
, NULL
);
1260 log_full_errno(IN_SET(r
, -ENOTTY
, -EOPNOTSUPP
) ? LOG_DEBUG
: LOG_WARNING
,
1262 "Cannot set file attribute for '%s', value=0x%08x, mask=0x%08x, ignoring: %m",
1263 path
, item
->attribute_value
, item
->attribute_mask
);
1268 static int path_set_attribute(Item
*item
, const char *path
) {
1269 _cleanup_close_
int fd
= -1;
1271 if (!item
->attribute_set
|| item
->attribute_mask
== 0)
1274 fd
= path_open_safe(path
);
1278 return fd_set_attribute(item
, fd
, path
, NULL
);
1281 static int write_one_file(Item
*i
, const char *path
) {
1282 _cleanup_close_
int fd
= -1, dir_fd
= -1;
1288 assert(i
->argument
);
1289 assert(i
->type
== WRITE_FILE
);
1291 /* Validate the path and keep the fd on the directory for opening the
1292 * file so we're sure that it can't be changed behind our back. */
1293 dir_fd
= path_open_parent_safe(path
);
1297 bn
= basename(path
);
1299 /* Follows symlinks */
1300 fd
= openat(dir_fd
, bn
, O_NONBLOCK
|O_CLOEXEC
|O_WRONLY
|O_NOCTTY
, i
->mode
);
1302 if (errno
== ENOENT
) {
1303 log_debug_errno(errno
, "Not writing missing file \"%s\": %m", path
);
1306 return log_error_errno(errno
, "Failed to open file \"%s\": %m", path
);
1309 /* 'w' is allowed to write into any kind of files. */
1310 log_debug("Writing to \"%s\".", path
);
1312 r
= loop_write(fd
, i
->argument
, strlen(i
->argument
), false);
1314 return log_error_errno(r
, "Failed to write file \"%s\": %m", path
);
1316 return fd_set_perms(i
, fd
, path
, NULL
);
1319 static int create_file(Item
*i
, const char *path
) {
1320 _cleanup_close_
int fd
= -1, dir_fd
= -1;
1321 struct stat stbuf
, *st
= NULL
;
1327 assert(i
->type
== CREATE_FILE
);
1329 /* 'f' operates on regular files exclusively. */
1331 /* Validate the path and keep the fd on the directory for opening the
1332 * file so we're sure that it can't be changed behind our back. */
1333 dir_fd
= path_open_parent_safe(path
);
1337 bn
= basename(path
);
1339 RUN_WITH_UMASK(0000) {
1340 mac_selinux_create_file_prepare(path
, S_IFREG
);
1341 fd
= openat(dir_fd
, bn
, O_CREAT
|O_EXCL
|O_NOFOLLOW
|O_NONBLOCK
|O_CLOEXEC
|O_WRONLY
|O_NOCTTY
, i
->mode
);
1342 mac_selinux_create_file_clear();
1346 /* Even on a read-only filesystem, open(2) returns EEXIST if the
1347 * file already exists. It returns EROFS only if it needs to
1348 * create the file. */
1349 if (errno
!= EEXIST
)
1350 return log_error_errno(errno
, "Failed to create file %s: %m", path
);
1352 /* Re-open the file. At that point it must exist since open(2)
1353 * failed with EEXIST. We still need to check if the perms/mode
1354 * need to be changed. For read-only filesystems, we let
1355 * fd_set_perms() report the error if the perms need to be
1357 fd
= openat(dir_fd
, bn
, O_NOFOLLOW
|O_CLOEXEC
|O_PATH
, i
->mode
);
1359 return log_error_errno(errno
, "Failed to re-open file %s: %m", path
);
1361 if (fstat(fd
, &stbuf
) < 0)
1362 return log_error_errno(errno
, "stat(%s) failed: %m", path
);
1364 if (!S_ISREG(stbuf
.st_mode
)) {
1365 log_error("%s exists and is not a regular file.", path
);
1372 log_debug("\"%s\" has been created.", path
);
1375 log_debug("Writing to \"%s\".", path
);
1377 r
= loop_write(fd
, i
->argument
, strlen(i
->argument
), false);
1379 return log_error_errno(r
, "Failed to write file \"%s\": %m", path
);
1383 return fd_set_perms(i
, fd
, path
, st
);
1386 static int truncate_file(Item
*i
, const char *path
) {
1387 _cleanup_close_
int fd
= -1, dir_fd
= -1;
1388 struct stat stbuf
, *st
= NULL
;
1395 assert(i
->type
== TRUNCATE_FILE
);
1397 /* We want to operate on regular file exclusively especially since
1398 * O_TRUNC is unspecified if the file is neither a regular file nor a
1399 * fifo nor a terminal device. Therefore we first open the file and make
1400 * sure it's a regular one before truncating it. */
1402 /* Validate the path and keep the fd on the directory for opening the
1403 * file so we're sure that it can't be changed behind our back. */
1404 dir_fd
= path_open_parent_safe(path
);
1408 bn
= basename(path
);
1410 RUN_WITH_UMASK(0000) {
1411 mac_selinux_create_file_prepare(path
, S_IFREG
);
1412 fd
= openat(dir_fd
, bn
, O_CREAT
|O_NOFOLLOW
|O_NONBLOCK
|O_CLOEXEC
|O_WRONLY
|O_NOCTTY
, i
->mode
);
1413 mac_selinux_create_file_clear();
1418 return log_error_errno(errno
, "Failed to open/create file %s: %m", path
);
1420 /* On a read-only filesystem, we don't want to fail if the
1421 * target is already empty and the perms are set. So we still
1422 * proceed with the sanity checks and let the remaining
1423 * operations fail with EROFS if they try to modify the target
1426 fd
= openat(dir_fd
, bn
, O_NOFOLLOW
|O_CLOEXEC
|O_PATH
, i
->mode
);
1428 if (errno
== ENOENT
) {
1429 log_error("Cannot create file %s on a read-only file system.", path
);
1433 return log_error_errno(errno
, "Failed to re-open file %s: %m", path
);
1439 if (fstat(fd
, &stbuf
) < 0)
1440 return log_error_errno(errno
, "stat(%s) failed: %m", path
);
1442 if (!S_ISREG(stbuf
.st_mode
)) {
1443 log_error("%s exists and is not a regular file.", path
);
1447 if (stbuf
.st_size
> 0) {
1448 if (ftruncate(fd
, 0) < 0) {
1449 r
= erofs
? -EROFS
: -errno
;
1450 return log_error_errno(r
, "Failed to truncate file %s: %m", path
);
1455 log_debug("\"%s\" has been created.", path
);
1458 log_debug("Writing to \"%s\".", path
);
1460 r
= loop_write(fd
, i
->argument
, strlen(i
->argument
), false);
1462 r
= erofs
? -EROFS
: r
;
1463 return log_error_errno(r
, "Failed to write file %s: %m", path
);
1467 return fd_set_perms(i
, fd
, path
, st
);
1470 static int copy_files(Item
*i
) {
1471 _cleanup_close_
int dfd
= -1, fd
= -1;
1475 log_debug("Copying tree \"%s\" to \"%s\".", i
->argument
, i
->path
);
1477 bn
= basename(i
->path
);
1479 /* Validate the path and use the returned directory fd for copying the
1480 * target so we're sure that the path can't be changed behind our
1482 dfd
= path_open_parent_safe(i
->path
);
1486 r
= copy_tree_at(AT_FDCWD
, i
->argument
,
1488 i
->uid_set
? i
->uid
: UID_INVALID
,
1489 i
->gid_set
? i
->gid
: GID_INVALID
,
1490 COPY_REFLINK
| COPY_MERGE_EMPTY
);
1494 /* If the target already exists on read-only filesystems, trying
1495 * to create the target will not fail with EEXIST but with
1497 if (r
== -EROFS
&& faccessat(dfd
, bn
, F_OK
, AT_SYMLINK_NOFOLLOW
) == 0)
1501 return log_error_errno(r
, "Failed to copy files to %s: %m", i
->path
);
1503 if (stat(i
->argument
, &a
) < 0)
1504 return log_error_errno(errno
, "stat(%s) failed: %m", i
->argument
);
1506 if (fstatat(dfd
, bn
, &b
, AT_SYMLINK_NOFOLLOW
) < 0)
1507 return log_error_errno(errno
, "stat(%s) failed: %m", i
->path
);
1509 if ((a
.st_mode
^ b
.st_mode
) & S_IFMT
) {
1510 log_debug("Can't copy to %s, file exists already and is of different type", i
->path
);
1515 fd
= openat(dfd
, bn
, O_NOFOLLOW
|O_CLOEXEC
|O_PATH
);
1517 return log_error_errno(errno
, "Failed to openat(%s): %m", i
->path
);
1519 return fd_set_perms(i
, fd
, i
->path
, NULL
);
1527 _CREATION_MODE_INVALID
= -1
1530 static const char *const creation_mode_verb_table
[_CREATION_MODE_MAX
] = {
1531 [CREATION_NORMAL
] = "Created",
1532 [CREATION_EXISTING
] = "Found existing",
1533 [CREATION_FORCE
] = "Created replacement",
1536 DEFINE_PRIVATE_STRING_TABLE_LOOKUP_TO_STRING(creation_mode_verb
, CreationMode
);
1538 static int create_directory_or_subvolume(const char *path
, mode_t mode
, bool subvol
, CreationMode
*creation
) {
1539 _cleanup_close_
int pfd
= -1;
1548 pfd
= path_open_parent_safe(path
);
1553 if (btrfs_is_subvol(empty_to_root(arg_root
)) <= 0)
1555 /* Don't create a subvolume unless the root directory is
1556 * one, too. We do this under the assumption that if the
1557 * root directory is just a plain directory (i.e. very
1558 * light-weight), we shouldn't try to split it up into
1559 * subvolumes (i.e. more heavy-weight). Thus, chroot()
1560 * environments and suchlike will get a full brtfs
1561 * subvolume set up below their tree only if they
1562 * specifically set up a btrfs subvolume for the root
1567 RUN_WITH_UMASK((~mode
) & 0777)
1568 r
= btrfs_subvol_make_fd(pfd
, basename(path
));
1573 if (!subvol
|| r
== -ENOTTY
)
1574 RUN_WITH_UMASK(0000)
1575 r
= mkdirat_label(pfd
, basename(path
), mode
);
1580 if (!IN_SET(r
, -EEXIST
, -EROFS
))
1581 return log_error_errno(r
, "Failed to create directory or subvolume \"%s\": %m", path
);
1584 if (k
== -ENOENT
&& r
== -EROFS
)
1585 return log_error_errno(r
, "%s does not exist and cannot be created as the file system is read-only.", path
);
1587 return log_error_errno(k
, "Failed to check if %s exists: %m", path
);
1589 log_warning("\"%s\" already exists and is not a directory.", path
);
1593 *creation
= CREATION_EXISTING
;
1595 *creation
= CREATION_NORMAL
;
1597 log_debug("%s directory \"%s\".", creation_mode_verb_to_string(*creation
), path
);
1599 r
= openat(pfd
, basename(path
), O_NOCTTY
|O_CLOEXEC
|O_DIRECTORY
);
1601 return log_error_errno(errno
, "Failed to open directory '%s': %m", basename(path
));
1606 static int create_directory(Item
*i
, const char *path
) {
1607 _cleanup_close_
int fd
= -1;
1610 assert(IN_SET(i
->type
, CREATE_DIRECTORY
, TRUNCATE_DIRECTORY
));
1612 fd
= create_directory_or_subvolume(path
, i
->mode
, false, NULL
);
1618 return fd_set_perms(i
, fd
, path
, NULL
);
1621 static int create_subvolume(Item
*i
, const char *path
) {
1622 _cleanup_close_
int fd
= -1;
1623 CreationMode creation
;
1627 assert(IN_SET(i
->type
, CREATE_SUBVOLUME
, CREATE_SUBVOLUME_NEW_QUOTA
, CREATE_SUBVOLUME_INHERIT_QUOTA
));
1629 fd
= create_directory_or_subvolume(path
, i
->mode
, true, &creation
);
1635 if (creation
== CREATION_NORMAL
&&
1636 IN_SET(i
->type
, CREATE_SUBVOLUME_NEW_QUOTA
, CREATE_SUBVOLUME_INHERIT_QUOTA
)) {
1637 r
= btrfs_subvol_auto_qgroup_fd(fd
, 0, i
->type
== CREATE_SUBVOLUME_NEW_QUOTA
);
1639 log_debug_errno(r
, "Couldn't adjust quota for subvolume \"%s\" (unsupported fs or dir not a subvolume): %m", i
->path
);
1640 else if (r
== -EROFS
)
1641 log_debug_errno(r
, "Couldn't adjust quota for subvolume \"%s\" (fs is read-only).", i
->path
);
1642 else if (r
== -ENOPROTOOPT
)
1643 log_debug_errno(r
, "Couldn't adjust quota for subvolume \"%s\" (quota support is disabled).", i
->path
);
1645 q
= log_error_errno(r
, "Failed to adjust quota for subvolume \"%s\": %m", i
->path
);
1647 log_debug("Adjusted quota for subvolume \"%s\".", i
->path
);
1649 log_debug("Quota for subvolume \"%s\" already in place, no change made.", i
->path
);
1652 r
= fd_set_perms(i
, fd
, path
, NULL
);
1653 if (q
< 0) /* prefer the quota change error from above */
1659 static int empty_directory(Item
*i
, const char *path
) {
1663 assert(i
->type
== EMPTY_DIRECTORY
);
1665 r
= is_dir(path
, false);
1667 /* Option "e" operates only on existing objects. Do not
1668 * print errors about non-existent files or directories */
1669 log_debug("Skipping missing directory: %s", path
);
1673 return log_error_errno(r
, "is_dir() failed on path %s: %m", path
);
1675 return log_error_errno(SYNTHETIC_ERRNO(EEXIST
),
1676 "'%s' already exists and is not a directory.",
1679 return path_set_perms(i
, path
);
1682 static int create_device(Item
*i
, mode_t file_type
) {
1683 _cleanup_close_
int dfd
= -1, fd
= -1;
1684 CreationMode creation
;
1689 assert(IN_SET(file_type
, S_IFBLK
, S_IFCHR
));
1691 bn
= basename(i
->path
);
1693 /* Validate the path and use the returned directory fd for copying the
1694 * target so we're sure that the path can't be changed behind our
1696 dfd
= path_open_parent_safe(i
->path
);
1700 RUN_WITH_UMASK(0000) {
1701 mac_selinux_create_file_prepare(i
->path
, file_type
);
1702 r
= mknodat(dfd
, bn
, i
->mode
| file_type
, i
->major_minor
);
1703 mac_selinux_create_file_clear();
1709 if (errno
== EPERM
) {
1710 log_debug("We lack permissions, possibly because of cgroup configuration; "
1711 "skipping creation of device node %s.", i
->path
);
1715 if (errno
!= EEXIST
)
1716 return log_error_errno(errno
, "Failed to create device node %s: %m", i
->path
);
1718 if (fstatat(dfd
, bn
, &st
, 0) < 0)
1719 return log_error_errno(errno
, "stat(%s) failed: %m", i
->path
);
1721 if ((st
.st_mode
& S_IFMT
) != file_type
) {
1725 RUN_WITH_UMASK(0000) {
1726 mac_selinux_create_file_prepare(i
->path
, file_type
);
1727 /* FIXME: need to introduce mknodat_atomic() */
1728 r
= mknod_atomic(i
->path
, i
->mode
| file_type
, i
->major_minor
);
1729 mac_selinux_create_file_clear();
1733 return log_error_errno(r
, "Failed to create device node \"%s\": %m", i
->path
);
1734 creation
= CREATION_FORCE
;
1736 log_debug("%s is not a device node.", i
->path
);
1740 creation
= CREATION_EXISTING
;
1742 creation
= CREATION_NORMAL
;
1744 log_debug("%s %s device node \"%s\" %u:%u.",
1745 creation_mode_verb_to_string(creation
),
1746 i
->type
== CREATE_BLOCK_DEVICE
? "block" : "char",
1747 i
->path
, major(i
->mode
), minor(i
->mode
));
1749 fd
= openat(dfd
, bn
, O_NOFOLLOW
|O_CLOEXEC
|O_PATH
);
1751 return log_error_errno(errno
, "Failed to openat(%s): %m", i
->path
);
1753 return fd_set_perms(i
, fd
, i
->path
, NULL
);
1756 static int create_fifo(Item
*i
, const char *path
) {
1757 _cleanup_close_
int pfd
= -1, fd
= -1;
1758 CreationMode creation
;
1763 pfd
= path_open_parent_safe(path
);
1767 bn
= basename(path
);
1769 RUN_WITH_UMASK(0000) {
1770 mac_selinux_create_file_prepare(path
, S_IFIFO
);
1771 r
= mkfifoat(pfd
, bn
, i
->mode
);
1772 mac_selinux_create_file_clear();
1776 if (errno
!= EEXIST
)
1777 return log_error_errno(errno
, "Failed to create fifo %s: %m", path
);
1779 if (fstatat(pfd
, bn
, &st
, AT_SYMLINK_NOFOLLOW
) < 0)
1780 return log_error_errno(errno
, "stat(%s) failed: %m", path
);
1782 if (!S_ISFIFO(st
.st_mode
)) {
1785 RUN_WITH_UMASK(0000) {
1786 mac_selinux_create_file_prepare(path
, S_IFIFO
);
1787 r
= mkfifoat_atomic(pfd
, bn
, i
->mode
);
1788 mac_selinux_create_file_clear();
1792 return log_error_errno(r
, "Failed to create fifo %s: %m", path
);
1793 creation
= CREATION_FORCE
;
1795 log_warning("\"%s\" already exists and is not a fifo.", path
);
1799 creation
= CREATION_EXISTING
;
1801 creation
= CREATION_NORMAL
;
1803 log_debug("%s fifo \"%s\".", creation_mode_verb_to_string(creation
), path
);
1805 fd
= openat(pfd
, bn
, O_NOFOLLOW
|O_CLOEXEC
|O_PATH
);
1807 return log_error_errno(errno
, "Failed to openat(%s): %m", path
);
1809 return fd_set_perms(i
, fd
, i
->path
, NULL
);
1812 typedef int (*action_t
)(Item
*i
, const char *path
);
1813 typedef int (*fdaction_t
)(Item
*i
, int fd
, const char *path
, const struct stat
*st
);
1815 static int item_do(Item
*i
, int fd
, const char *path
, fdaction_t action
) {
1823 if (fstat(fd
, &st
) < 0) {
1824 r
= log_error_errno(errno
, "fstat() on file failed: %m");
1828 /* This returns the first error we run into, but nevertheless
1830 r
= action(i
, fd
, path
, &st
);
1832 if (S_ISDIR(st
.st_mode
)) {
1833 char procfs_path
[STRLEN("/proc/self/fd/") + DECIMAL_STR_MAX(int)];
1834 _cleanup_closedir_
DIR *d
= NULL
;
1837 /* The passed 'fd' was opened with O_PATH. We need to convert
1838 * it into a 'regular' fd before reading the directory content. */
1839 xsprintf(procfs_path
, "/proc/self/fd/%i", fd
);
1841 d
= opendir(procfs_path
);
1843 log_error_errno(errno
, "Failed to opendir() '%s': %m", procfs_path
);
1849 FOREACH_DIRENT_ALL(de
, d
, q
= -errno
; goto finish
) {
1852 if (dot_or_dot_dot(de
->d_name
))
1855 de_fd
= openat(fd
, de
->d_name
, O_NOFOLLOW
|O_CLOEXEC
|O_PATH
);
1857 q
= log_error_errno(errno
, "Failed to open() file '%s': %m", de
->d_name
);
1859 _cleanup_free_
char *de_path
= NULL
;
1861 de_path
= path_join(path
, de
->d_name
);
1865 /* Pass ownership of dirent fd over */
1866 q
= item_do(i
, de_fd
, de_path
, action
);
1869 if (q
< 0 && r
== 0)
1878 static int glob_item(Item
*i
, action_t action
) {
1879 _cleanup_globfree_ glob_t g
= {
1880 .gl_opendir
= (void *(*)(const char *)) opendir_nomod
,
1885 k
= safe_glob(i
->path
, GLOB_NOSORT
|GLOB_BRACE
, &g
);
1886 if (k
< 0 && k
!= -ENOENT
)
1887 return log_error_errno(k
, "glob(%s) failed: %m", i
->path
);
1889 STRV_FOREACH(fn
, g
.gl_pathv
) {
1891 if (k
< 0 && r
== 0)
1898 static int glob_item_recursively(Item
*i
, fdaction_t action
) {
1899 _cleanup_globfree_ glob_t g
= {
1900 .gl_opendir
= (void *(*)(const char *)) opendir_nomod
,
1905 k
= safe_glob(i
->path
, GLOB_NOSORT
|GLOB_BRACE
, &g
);
1906 if (k
< 0 && k
!= -ENOENT
)
1907 return log_error_errno(k
, "glob(%s) failed: %m", i
->path
);
1909 STRV_FOREACH(fn
, g
.gl_pathv
) {
1910 _cleanup_close_
int fd
= -1;
1912 /* Make sure we won't trigger/follow file object (such as
1913 * device nodes, automounts, ...) pointed out by 'fn' with
1914 * O_PATH. Note, when O_PATH is used, flags other than
1915 * O_CLOEXEC, O_DIRECTORY, and O_NOFOLLOW are ignored. */
1917 fd
= open(*fn
, O_CLOEXEC
|O_NOFOLLOW
|O_PATH
);
1919 log_error_errno(errno
, "Opening '%s' failed: %m", *fn
);
1925 k
= item_do(i
, fd
, *fn
, action
);
1926 if (k
< 0 && r
== 0)
1929 /* we passed fd ownership to the previous call */
1936 static int create_item(Item
*i
) {
1937 CreationMode creation
;
1942 log_debug("Running create action for entry %c %s", (char) i
->type
, i
->path
);
1947 case IGNORE_DIRECTORY_PATH
:
1949 case RECURSIVE_REMOVE_PATH
:
1953 RUN_WITH_UMASK(0000)
1954 (void) mkdir_parents_label(i
->path
, 0755);
1956 r
= create_file(i
, i
->path
);
1962 RUN_WITH_UMASK(0000)
1963 (void) mkdir_parents_label(i
->path
, 0755);
1965 r
= truncate_file(i
, i
->path
);
1971 RUN_WITH_UMASK(0000)
1972 (void) mkdir_parents_label(i
->path
, 0755);
1980 r
= glob_item(i
, write_one_file
);
1986 case CREATE_DIRECTORY
:
1987 case TRUNCATE_DIRECTORY
:
1988 RUN_WITH_UMASK(0000)
1989 (void) mkdir_parents_label(i
->path
, 0755);
1991 r
= create_directory(i
, i
->path
);
1996 case CREATE_SUBVOLUME
:
1997 case CREATE_SUBVOLUME_INHERIT_QUOTA
:
1998 case CREATE_SUBVOLUME_NEW_QUOTA
:
1999 RUN_WITH_UMASK(0000)
2000 (void) mkdir_parents_label(i
->path
, 0755);
2002 r
= create_subvolume(i
, i
->path
);
2007 case EMPTY_DIRECTORY
:
2008 r
= glob_item(i
, empty_directory
);
2014 RUN_WITH_UMASK(0000)
2015 (void) mkdir_parents_label(i
->path
, 0755);
2017 r
= create_fifo(i
, i
->path
);
2022 case CREATE_SYMLINK
: {
2023 RUN_WITH_UMASK(0000)
2024 (void) mkdir_parents_label(i
->path
, 0755);
2026 mac_selinux_create_file_prepare(i
->path
, S_IFLNK
);
2027 r
= symlink(i
->argument
, i
->path
);
2028 mac_selinux_create_file_clear();
2031 _cleanup_free_
char *x
= NULL
;
2033 if (errno
!= EEXIST
)
2034 return log_error_errno(errno
, "symlink(%s, %s) failed: %m", i
->argument
, i
->path
);
2036 r
= readlink_malloc(i
->path
, &x
);
2037 if (r
< 0 || !streq(i
->argument
, x
)) {
2040 mac_selinux_create_file_prepare(i
->path
, S_IFLNK
);
2041 r
= symlink_atomic(i
->argument
, i
->path
);
2042 mac_selinux_create_file_clear();
2044 if (IN_SET(r
, -EISDIR
, -EEXIST
, -ENOTEMPTY
)) {
2045 r
= rm_rf(i
->path
, REMOVE_ROOT
|REMOVE_PHYSICAL
);
2047 return log_error_errno(r
, "rm -fr %s failed: %m", i
->path
);
2049 mac_selinux_create_file_prepare(i
->path
, S_IFLNK
);
2050 r
= symlink(i
->argument
, i
->path
) < 0 ? -errno
: 0;
2051 mac_selinux_create_file_clear();
2054 return log_error_errno(r
, "symlink(%s, %s) failed: %m", i
->argument
, i
->path
);
2056 creation
= CREATION_FORCE
;
2058 log_debug("\"%s\" is not a symlink or does not point to the correct path.", i
->path
);
2062 creation
= CREATION_EXISTING
;
2065 creation
= CREATION_NORMAL
;
2066 log_debug("%s symlink \"%s\".", creation_mode_verb_to_string(creation
), i
->path
);
2070 case CREATE_BLOCK_DEVICE
:
2071 case CREATE_CHAR_DEVICE
:
2072 if (have_effective_cap(CAP_MKNOD
) == 0) {
2073 /* In a container we lack CAP_MKNOD. We shouldn't attempt to create the device node in that
2074 * case to avoid noise, and we don't support virtualized devices in containers anyway. */
2076 log_debug("We lack CAP_MKNOD, skipping creation of device node %s.", i
->path
);
2080 RUN_WITH_UMASK(0000)
2081 (void) mkdir_parents_label(i
->path
, 0755);
2083 r
= create_device(i
, i
->type
== CREATE_BLOCK_DEVICE
? S_IFBLK
: S_IFCHR
);
2091 r
= glob_item(i
, path_set_perms
);
2096 case RECURSIVE_RELABEL_PATH
:
2097 r
= glob_item_recursively(i
, fd_set_perms
);
2103 r
= glob_item(i
, path_set_xattrs
);
2108 case RECURSIVE_SET_XATTR
:
2109 r
= glob_item_recursively(i
, fd_set_xattrs
);
2115 r
= glob_item(i
, path_set_acls
);
2120 case RECURSIVE_SET_ACL
:
2121 r
= glob_item_recursively(i
, fd_set_acls
);
2127 r
= glob_item(i
, path_set_attribute
);
2132 case RECURSIVE_SET_ATTRIBUTE
:
2133 r
= glob_item_recursively(i
, fd_set_attribute
);
2142 static int remove_item_instance(Item
*i
, const char *instance
) {
2150 if (remove(instance
) < 0 && errno
!= ENOENT
)
2151 return log_error_errno(errno
, "rm(%s): %m", instance
);
2155 case RECURSIVE_REMOVE_PATH
:
2156 /* FIXME: we probably should use dir_cleanup() here instead of rm_rf() so that 'x' is honoured. */
2157 log_debug("rm -rf \"%s\"", instance
);
2158 r
= rm_rf(instance
, REMOVE_ROOT
|REMOVE_SUBVOLUME
|REMOVE_PHYSICAL
);
2159 if (r
< 0 && r
!= -ENOENT
)
2160 return log_error_errno(r
, "rm_rf(%s): %m", instance
);
2165 assert_not_reached("wut?");
2171 static int remove_item(Item
*i
) {
2176 log_debug("Running remove action for entry %c %s", (char) i
->type
, i
->path
);
2180 case TRUNCATE_DIRECTORY
:
2181 /* FIXME: we probably should use dir_cleanup() here instead of rm_rf() so that 'x' is honoured. */
2182 log_debug("rm -rf \"%s\"", i
->path
);
2183 r
= rm_rf(i
->path
, REMOVE_PHYSICAL
);
2184 if (r
< 0 && r
!= -ENOENT
)
2185 return log_error_errno(r
, "rm_rf(%s): %m", i
->path
);
2190 case RECURSIVE_REMOVE_PATH
:
2191 return glob_item(i
, remove_item_instance
);
2198 static int clean_item_instance(Item
*i
, const char* instance
) {
2199 _cleanup_closedir_
DIR *d
= NULL
;
2203 char timestamp
[FORMAT_TIMESTAMP_MAX
];
2210 n
= now(CLOCK_REALTIME
);
2214 cutoff
= n
- i
->age
;
2216 d
= opendir_nomod(instance
);
2218 if (IN_SET(errno
, ENOENT
, ENOTDIR
)) {
2219 log_debug_errno(errno
, "Directory \"%s\": %m", instance
);
2223 return log_error_errno(errno
, "Failed to open directory %s: %m", instance
);
2226 if (fstat(dirfd(d
), &s
) < 0)
2227 return log_error_errno(errno
, "stat(%s) failed: %m", i
->path
);
2229 if (!S_ISDIR(s
.st_mode
))
2230 return log_error_errno(SYNTHETIC_ERRNO(ENOTDIR
),
2231 "%s is not a directory.", i
->path
);
2233 if (fstatat(dirfd(d
), "..", &ps
, AT_SYMLINK_NOFOLLOW
) != 0)
2234 return log_error_errno(errno
, "stat(%s/..) failed: %m", i
->path
);
2236 mountpoint
= s
.st_dev
!= ps
.st_dev
|| s
.st_ino
== ps
.st_ino
;
2238 log_debug("Cleanup threshold for %s \"%s\" is %s",
2239 mountpoint
? "mount point" : "directory",
2241 format_timestamp_us(timestamp
, sizeof(timestamp
), cutoff
));
2243 return dir_cleanup(i
, instance
, d
, &s
, cutoff
, s
.st_dev
, mountpoint
,
2244 MAX_DEPTH
, i
->keep_first_level
);
2247 static int clean_item(Item
*i
) {
2250 log_debug("Running clean action for entry %c %s", (char) i
->type
, i
->path
);
2253 case CREATE_DIRECTORY
:
2254 case CREATE_SUBVOLUME
:
2255 case CREATE_SUBVOLUME_INHERIT_QUOTA
:
2256 case CREATE_SUBVOLUME_NEW_QUOTA
:
2257 case TRUNCATE_DIRECTORY
:
2260 clean_item_instance(i
, i
->path
);
2262 case EMPTY_DIRECTORY
:
2263 case IGNORE_DIRECTORY_PATH
:
2264 return glob_item(i
, clean_item_instance
);
2270 static int process_item(Item
*i
, OperationMask operation
) {
2276 todo
= operation
& ~i
->done
;
2277 if (todo
== 0) /* Everything already done? */
2280 i
->done
|= operation
;
2282 r
= chase_symlinks(i
->path
, arg_root
, CHASE_NO_AUTOFS
|CHASE_WARN
, NULL
);
2283 if (r
== -EREMOTE
) {
2284 log_notice_errno(r
, "Skipping %s", i
->path
);
2288 log_debug_errno(r
, "Failed to determine whether '%s' is below autofs, ignoring: %m", i
->path
);
2290 r
= FLAGS_SET(operation
, OPERATION_CREATE
) ? create_item(i
) : 0;
2291 /* Failure can only be tolerated for create */
2292 if (i
->allow_failure
)
2295 q
= FLAGS_SET(operation
, OPERATION_REMOVE
) ? remove_item(i
) : 0;
2296 p
= FLAGS_SET(operation
, OPERATION_CLEAN
) ? clean_item(i
) : 0;
2303 static int process_item_array(ItemArray
*array
, OperationMask operation
) {
2309 /* Create any parent first. */
2310 if (FLAGS_SET(operation
, OPERATION_CREATE
) && array
->parent
)
2311 r
= process_item_array(array
->parent
, operation
& OPERATION_CREATE
);
2313 /* Clean up all children first */
2314 if ((operation
& (OPERATION_REMOVE
|OPERATION_CLEAN
)) && !set_isempty(array
->children
)) {
2318 SET_FOREACH(c
, array
->children
, i
) {
2321 k
= process_item_array(c
, operation
& (OPERATION_REMOVE
|OPERATION_CLEAN
));
2322 if (k
< 0 && r
== 0)
2327 for (n
= 0; n
< array
->n_items
; n
++) {
2330 k
= process_item(array
->items
+ n
, operation
);
2331 if (k
< 0 && r
== 0)
2338 static void item_free_contents(Item
*i
) {
2342 strv_free(i
->xattrs
);
2345 acl_free(i
->acl_access
);
2346 acl_free(i
->acl_default
);
2350 static ItemArray
* item_array_free(ItemArray
*a
) {
2356 for (n
= 0; n
< a
->n_items
; n
++)
2357 item_free_contents(a
->items
+ n
);
2359 set_free(a
->children
);
2364 static int item_compare(const Item
*a
, const Item
*b
) {
2365 /* Make sure that the ownership taking item is put first, so
2366 * that we first create the node, and then can adjust it */
2368 if (takes_ownership(a
->type
) && !takes_ownership(b
->type
))
2370 if (!takes_ownership(a
->type
) && takes_ownership(b
->type
))
2373 return CMP(a
->type
, b
->type
);
2376 static bool item_compatible(Item
*a
, Item
*b
) {
2379 assert(streq(a
->path
, b
->path
));
2381 if (takes_ownership(a
->type
) && takes_ownership(b
->type
))
2382 /* check if the items are the same */
2383 return streq_ptr(a
->argument
, b
->argument
) &&
2385 a
->uid_set
== b
->uid_set
&&
2388 a
->gid_set
== b
->gid_set
&&
2391 a
->mode_set
== b
->mode_set
&&
2392 a
->mode
== b
->mode
&&
2394 a
->age_set
== b
->age_set
&&
2397 a
->mask_perms
== b
->mask_perms
&&
2399 a
->keep_first_level
== b
->keep_first_level
&&
2401 a
->major_minor
== b
->major_minor
;
2406 static bool should_include_path(const char *path
) {
2409 STRV_FOREACH(prefix
, arg_exclude_prefixes
)
2410 if (path_startswith(path
, *prefix
)) {
2411 log_debug("Entry \"%s\" matches exclude prefix \"%s\", skipping.",
2416 STRV_FOREACH(prefix
, arg_include_prefixes
)
2417 if (path_startswith(path
, *prefix
)) {
2418 log_debug("Entry \"%s\" matches include prefix \"%s\".", path
, *prefix
);
2422 /* no matches, so we should include this path only if we
2423 * have no whitelist at all */
2424 if (strv_isempty(arg_include_prefixes
))
2427 log_debug("Entry \"%s\" does not match any include prefix, skipping.", path
);
2431 static int specifier_expansion_from_arg(Item
*i
) {
2432 _cleanup_free_
char *unescaped
= NULL
, *resolved
= NULL
;
2443 case CREATE_SYMLINK
:
2447 r
= cunescape(i
->argument
, 0, &unescaped
);
2449 return log_error_errno(r
, "Failed to unescape parameter to write: %s", i
->argument
);
2451 r
= specifier_printf(unescaped
, specifier_table
, NULL
, &resolved
);
2455 free_and_replace(i
->argument
, resolved
);
2459 case RECURSIVE_SET_XATTR
:
2462 STRV_FOREACH (xattr
, i
->xattrs
) {
2463 r
= specifier_printf(*xattr
, specifier_table
, NULL
, &resolved
);
2467 free_and_replace(*xattr
, resolved
);
2477 static int patch_var_run(const char *fname
, unsigned line
, char **path
) {
2484 /* Optionally rewrites lines referencing /var/run/, to use /run/ instead. Why bother? tmpfiles merges lines in
2485 * some cases and detects conflicts in others. If files/directories are specified through two equivalent lines
2486 * this is problematic as neither case will be detected. Ideally we'd detect these cases by resolving symlinks
2487 * early, but that's precisely not what we can do here as this code very likely is running very early on, at a
2488 * time where the paths in question are not available yet, or even more importantly, our own tmpfiles rules
2489 * might create the paths that are intermediary to the listed paths. We can't really cover the generic case,
2490 * but the least we can do is cover the specific case of /var/run vs. /run, as /var/run is a legacy name for
2491 * /run only, and we explicitly document that and require that on systemd systems the former is a symlink to
2492 * the latter. Moreover files below this path are by far the primary usecase for tmpfiles.d/. */
2494 k
= path_startswith(*path
, "/var/run/");
2495 if (isempty(k
)) /* Don't complain about other paths than /var/run, and not about /var/run itself either. */
2498 n
= strjoin("/run/", k
);
2502 /* Also log about this briefly. We do so at LOG_NOTICE level, as we fixed up the situation automatically, hence
2503 * there's no immediate need for action by the user. However, in the interest of making things less confusing
2504 * to the user, let's still inform the user that these snippets should really be updated. */
2506 log_notice("[%s:%u] Line references path below legacy directory /var/run/, updating %s → %s; please update the tmpfiles.d/ drop-in file accordingly.", fname
, line
, *path
, n
);
2508 free_and_replace(*path
, n
);
2513 static int parse_line(const char *fname
, unsigned line
, const char *buffer
, bool *invalid_config
) {
2515 _cleanup_free_
char *action
= NULL
, *mode
= NULL
, *user
= NULL
, *group
= NULL
, *age
= NULL
, *path
= NULL
;
2516 _cleanup_(item_free_contents
) Item i
= {};
2517 ItemArray
*existing
;
2520 bool force
= false, boot
= false, allow_failure
= false;
2526 r
= extract_many_words(
2538 if (IN_SET(r
, -EINVAL
, -EBADSLT
))
2539 /* invalid quoting and such or an unknown specifier */
2540 *invalid_config
= true;
2541 return log_error_errno(r
, "[%s:%u] Failed to parse line: %m", fname
, line
);
2543 *invalid_config
= true;
2544 log_error("[%s:%u] Syntax error.", fname
, line
);
2548 if (!empty_or_dash(buffer
)) {
2549 i
.argument
= strdup(buffer
);
2554 if (isempty(action
)) {
2555 *invalid_config
= true;
2556 log_error("[%s:%u] Command too short '%s'.", fname
, line
, action
);
2560 for (pos
= 1; action
[pos
]; pos
++) {
2561 if (action
[pos
] == '!' && !boot
)
2563 else if (action
[pos
] == '+' && !force
)
2565 else if (action
[pos
] == '-' && !allow_failure
)
2566 allow_failure
= true;
2568 *invalid_config
= true;
2569 log_error("[%s:%u] Unknown modifiers in command '%s'",
2570 fname
, line
, action
);
2575 if (boot
&& !arg_boot
) {
2576 log_debug("Ignoring entry %s \"%s\" because --boot is not specified.",
2583 i
.allow_failure
= allow_failure
;
2585 r
= specifier_printf(path
, specifier_table
, NULL
, &i
.path
);
2587 return log_unresolvable_specifier(fname
, line
);
2589 if (IN_SET(r
, -EINVAL
, -EBADSLT
))
2590 *invalid_config
= true;
2591 return log_error_errno(r
, "[%s:%u] Failed to replace specifiers: %s", fname
, line
, path
);
2594 r
= patch_var_run(fname
, line
, &i
.path
);
2600 case CREATE_DIRECTORY
:
2601 case CREATE_SUBVOLUME
:
2602 case CREATE_SUBVOLUME_INHERIT_QUOTA
:
2603 case CREATE_SUBVOLUME_NEW_QUOTA
:
2604 case EMPTY_DIRECTORY
:
2605 case TRUNCATE_DIRECTORY
:
2608 case IGNORE_DIRECTORY_PATH
:
2610 case RECURSIVE_REMOVE_PATH
:
2613 case RECURSIVE_RELABEL_PATH
:
2615 log_warning("[%s:%u] %c lines don't take argument fields, ignoring.", fname
, line
, i
.type
);
2623 case CREATE_SYMLINK
:
2625 i
.argument
= strappend("/usr/share/factory/", i
.path
);
2633 *invalid_config
= true;
2634 log_error("[%s:%u] Write file requires argument.", fname
, line
);
2641 i
.argument
= strappend("/usr/share/factory/", i
.path
);
2644 } else if (!path_is_absolute(i
.argument
)) {
2645 *invalid_config
= true;
2646 log_error("[%s:%u] Source path is not absolute.", fname
, line
);
2650 path_simplify(i
.argument
, false);
2653 case CREATE_CHAR_DEVICE
:
2654 case CREATE_BLOCK_DEVICE
:
2656 *invalid_config
= true;
2657 log_error("[%s:%u] Device file requires argument.", fname
, line
);
2661 r
= parse_dev(i
.argument
, &i
.major_minor
);
2663 *invalid_config
= true;
2664 log_error_errno(r
, "[%s:%u] Can't parse device file major/minor '%s'.", fname
, line
, i
.argument
);
2671 case RECURSIVE_SET_XATTR
:
2673 *invalid_config
= true;
2674 log_error("[%s:%u] Set extended attribute requires argument.", fname
, line
);
2677 r
= parse_xattrs_from_arg(&i
);
2683 case RECURSIVE_SET_ACL
:
2685 *invalid_config
= true;
2686 log_error("[%s:%u] Set ACLs requires argument.", fname
, line
);
2689 r
= parse_acls_from_arg(&i
);
2695 case RECURSIVE_SET_ATTRIBUTE
:
2697 *invalid_config
= true;
2698 log_error("[%s:%u] Set file attribute requires argument.", fname
, line
);
2701 r
= parse_attribute_from_arg(&i
);
2702 if (IN_SET(r
, -EINVAL
, -EBADSLT
))
2703 *invalid_config
= true;
2709 log_error("[%s:%u] Unknown command type '%c'.", fname
, line
, (char) i
.type
);
2710 *invalid_config
= true;
2714 if (!path_is_absolute(i
.path
)) {
2715 log_error("[%s:%u] Path '%s' not absolute.", fname
, line
, i
.path
);
2716 *invalid_config
= true;
2720 path_simplify(i
.path
, false);
2722 if (!should_include_path(i
.path
))
2725 r
= specifier_expansion_from_arg(&i
);
2727 return log_unresolvable_specifier(fname
, line
);
2729 if (IN_SET(r
, -EINVAL
, -EBADSLT
))
2730 *invalid_config
= true;
2731 return log_error_errno(r
, "[%s:%u] Failed to substitute specifiers in argument: %m",
2738 p
= prefix_root(arg_root
, i
.path
);
2742 free_and_replace(i
.path
, p
);
2745 if (!empty_or_dash(user
)) {
2746 const char *u
= user
;
2748 r
= get_user_creds(&u
, &i
.uid
, NULL
, NULL
, NULL
, USER_CREDS_ALLOW_MISSING
);
2750 *invalid_config
= true;
2751 return log_error_errno(r
, "[%s:%u] Unknown user '%s'.", fname
, line
, user
);
2757 if (!empty_or_dash(group
)) {
2758 const char *g
= group
;
2760 r
= get_group_creds(&g
, &i
.gid
, USER_CREDS_ALLOW_MISSING
);
2762 *invalid_config
= true;
2763 log_error("[%s:%u] Unknown group '%s'.", fname
, line
, group
);
2770 if (!empty_or_dash(mode
)) {
2771 const char *mm
= mode
;
2775 i
.mask_perms
= true;
2779 if (parse_mode(mm
, &m
) < 0) {
2780 *invalid_config
= true;
2781 log_error("[%s:%u] Invalid mode '%s'.", fname
, line
, mode
);
2788 i
.mode
= IN_SET(i
.type
, CREATE_DIRECTORY
, TRUNCATE_DIRECTORY
, CREATE_SUBVOLUME
, CREATE_SUBVOLUME_INHERIT_QUOTA
, CREATE_SUBVOLUME_NEW_QUOTA
) ? 0755 : 0644;
2790 if (!empty_or_dash(age
)) {
2791 const char *a
= age
;
2794 i
.keep_first_level
= true;
2798 if (parse_sec(a
, &i
.age
) < 0) {
2799 *invalid_config
= true;
2800 log_error("[%s:%u] Invalid age '%s'.", fname
, line
, age
);
2807 h
= needs_glob(i
.type
) ? globs
: items
;
2809 existing
= ordered_hashmap_get(h
, i
.path
);
2813 for (n
= 0; n
< existing
->n_items
; n
++) {
2814 if (!item_compatible(existing
->items
+ n
, &i
)) {
2815 log_notice("[%s:%u] Duplicate line for path \"%s\", ignoring.",
2816 fname
, line
, i
.path
);
2821 existing
= new0(ItemArray
, 1);
2825 r
= ordered_hashmap_put(h
, i
.path
, existing
);
2832 if (!GREEDY_REALLOC(existing
->items
, existing
->allocated
, existing
->n_items
+ 1))
2835 existing
->items
[existing
->n_items
++] = i
;
2836 i
= (struct Item
) {};
2838 /* Sort item array, to enforce stable ordering of application */
2839 typesafe_qsort(existing
->items
, existing
->n_items
, item_compare
);
2844 static int cat_config(char **config_dirs
, char **args
) {
2845 _cleanup_strv_free_
char **files
= NULL
;
2848 r
= conf_files_list_with_replacement(arg_root
, config_dirs
, arg_replace
, &files
, NULL
);
2852 return cat_files(NULL
, files
, 0);
2855 static int help(void) {
2856 _cleanup_free_
char *link
= NULL
;
2859 r
= terminal_urlify_man("systemd-tmpfiles", "8", &link
);
2863 printf("%s [OPTIONS...] [CONFIGURATION FILE...]\n\n"
2864 "Creates, deletes and cleans up volatile and temporary files and directories.\n\n"
2865 " -h --help Show this help\n"
2866 " --user Execute user configuration\n"
2867 " --version Show package version\n"
2868 " --cat-config Show configuration files\n"
2869 " --create Create marked files/directories\n"
2870 " --clean Clean up marked directories\n"
2871 " --remove Remove marked files/directories\n"
2872 " --boot Execute actions only safe at boot\n"
2873 " --prefix=PATH Only apply rules with the specified prefix\n"
2874 " --exclude-prefix=PATH Ignore rules with the specified prefix\n"
2875 " --root=PATH Operate on an alternate filesystem root\n"
2876 " --replace=PATH Treat arguments as replacement for PATH\n"
2877 " --no-pager Do not pipe output into a pager\n"
2878 "\nSee the %s for details.\n"
2879 , program_invocation_short_name
2886 static int parse_argv(int argc
, char *argv
[]) {
2889 ARG_VERSION
= 0x100,
2903 static const struct option options
[] = {
2904 { "help", no_argument
, NULL
, 'h' },
2905 { "user", no_argument
, NULL
, ARG_USER
},
2906 { "version", no_argument
, NULL
, ARG_VERSION
},
2907 { "cat-config", no_argument
, NULL
, ARG_CAT_CONFIG
},
2908 { "create", no_argument
, NULL
, ARG_CREATE
},
2909 { "clean", no_argument
, NULL
, ARG_CLEAN
},
2910 { "remove", no_argument
, NULL
, ARG_REMOVE
},
2911 { "boot", no_argument
, NULL
, ARG_BOOT
},
2912 { "prefix", required_argument
, NULL
, ARG_PREFIX
},
2913 { "exclude-prefix", required_argument
, NULL
, ARG_EXCLUDE_PREFIX
},
2914 { "root", required_argument
, NULL
, ARG_ROOT
},
2915 { "replace", required_argument
, NULL
, ARG_REPLACE
},
2916 { "no-pager", no_argument
, NULL
, ARG_NO_PAGER
},
2925 while ((c
= getopt_long(argc
, argv
, "h", options
, NULL
)) >= 0)
2935 case ARG_CAT_CONFIG
:
2936 arg_cat_config
= true;
2944 arg_operation
|= OPERATION_CREATE
;
2948 arg_operation
|= OPERATION_CLEAN
;
2952 arg_operation
|= OPERATION_REMOVE
;
2960 if (strv_push(&arg_include_prefixes
, optarg
) < 0)
2964 case ARG_EXCLUDE_PREFIX
:
2965 if (strv_push(&arg_exclude_prefixes
, optarg
) < 0)
2970 r
= parse_path_argument_and_warn(optarg
, true, &arg_root
);
2976 if (!path_is_absolute(optarg
) ||
2977 !endswith(optarg
, ".conf"))
2978 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
2979 "The argument to --replace= must an absolute path to a config file");
2981 arg_replace
= optarg
;
2985 arg_pager_flags
|= PAGER_DISABLE
;
2992 assert_not_reached("Unhandled option");
2995 if (arg_operation
== 0 && !arg_cat_config
)
2996 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
2997 "You need to specify at least one of --clean, --create or --remove.");
2999 if (arg_replace
&& arg_cat_config
)
3000 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
3001 "Option --replace= is not supported with --cat-config");
3003 if (arg_replace
&& optind
>= argc
)
3004 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
3005 "When --replace= is given, some configuration items must be specified");
3010 static int read_config_file(char **config_dirs
, const char *fn
, bool ignore_enoent
, bool *invalid_config
) {
3011 _cleanup_fclose_
FILE *_f
= NULL
;
3020 if (streq(fn
, "-")) {
3021 log_debug("Reading config from stdin…");
3025 r
= search_and_fopen(fn
, "re", arg_root
, (const char**) config_dirs
, &_f
);
3027 if (ignore_enoent
&& r
== -ENOENT
) {
3028 log_debug_errno(r
, "Failed to open \"%s\", ignoring: %m", fn
);
3032 return log_error_errno(r
, "Failed to open '%s': %m", fn
);
3034 log_debug("Reading config file \"%s\"…", fn
);
3039 _cleanup_free_
char *line
= NULL
;
3040 bool invalid_line
= false;
3044 k
= read_line(f
, LONG_LINE_MAX
, &line
);
3046 return log_error_errno(k
, "Failed to read '%s': %m", fn
);
3053 if (IN_SET(*l
, 0, '#'))
3056 k
= parse_line(fn
, v
, l
, &invalid_line
);
3059 /* Allow reporting with a special code if the caller requested this */
3060 *invalid_config
= true;
3062 /* The first error becomes our return value */
3067 /* we have to determine age parameter for each entry of type X */
3068 ORDERED_HASHMAP_FOREACH(i
, globs
, iterator
) {
3070 Item
*j
, *candidate_item
= NULL
;
3072 if (i
->type
!= IGNORE_DIRECTORY_PATH
)
3075 ORDERED_HASHMAP_FOREACH(j
, items
, iter
) {
3076 if (!IN_SET(j
->type
, CREATE_DIRECTORY
, TRUNCATE_DIRECTORY
, CREATE_SUBVOLUME
, CREATE_SUBVOLUME_INHERIT_QUOTA
, CREATE_SUBVOLUME_NEW_QUOTA
))
3079 if (path_equal(j
->path
, i
->path
)) {
3084 if ((!candidate_item
&& path_startswith(i
->path
, j
->path
)) ||
3085 (candidate_item
&& path_startswith(j
->path
, candidate_item
->path
) && (fnmatch(i
->path
, j
->path
, FNM_PATHNAME
| FNM_PERIOD
) == 0)))
3089 if (candidate_item
&& candidate_item
->age_set
) {
3090 i
->age
= candidate_item
->age
;
3096 log_error_errno(errno
, "Failed to read from file %s: %m", fn
);
3104 static int parse_arguments(char **config_dirs
, char **args
, bool *invalid_config
) {
3108 STRV_FOREACH(arg
, args
) {
3109 r
= read_config_file(config_dirs
, *arg
, false, invalid_config
);
3117 static int read_config_files(char **config_dirs
, char **args
, bool *invalid_config
) {
3118 _cleanup_strv_free_
char **files
= NULL
;
3119 _cleanup_free_
char *p
= NULL
;
3123 r
= conf_files_list_with_replacement(arg_root
, config_dirs
, arg_replace
, &files
, &p
);
3127 STRV_FOREACH(f
, files
)
3128 if (p
&& path_equal(*f
, p
)) {
3129 log_debug("Parsing arguments at position \"%s\"…", *f
);
3131 r
= parse_arguments(config_dirs
, args
, invalid_config
);
3135 /* Just warn, ignore result otherwise.
3136 * read_config_file() has some debug output, so no need to print anything. */
3137 (void) read_config_file(config_dirs
, *f
, true, invalid_config
);
3142 static int link_parent(ItemArray
*a
) {
3149 /* Finds the closest "parent" item array for the specified item array. Then registers the specified item array
3150 * as child of it, and fills the parent in, linking them both ways. This allows us to later create parents
3151 * before their children, and clean up/remove children before their parents. */
3153 if (a
->n_items
<= 0)
3156 path
= a
->items
[0].path
;
3157 prefix
= newa(char, strlen(path
) + 1);
3158 PATH_FOREACH_PREFIX(prefix
, path
) {
3161 j
= ordered_hashmap_get(items
, prefix
);
3163 j
= ordered_hashmap_get(globs
, prefix
);
3165 r
= set_ensure_allocated(&j
->children
, NULL
);
3169 r
= set_put(j
->children
, a
);
3181 DEFINE_PRIVATE_HASH_OPS_WITH_VALUE_DESTRUCTOR(item_array_hash_ops
, char, string_hash_func
, string_compare_func
,
3182 ItemArray
, item_array_free
);
3184 static int run(int argc
, char *argv
[]) {
3185 _cleanup_strv_free_
char **config_dirs
= NULL
;
3186 bool invalid_config
= false;
3190 PHASE_REMOVE_AND_CLEAN
,
3196 r
= parse_argv(argc
, argv
);
3200 log_setup_service();
3202 /* Descending down file system trees might take a lot of fds */
3203 (void) rlimit_nofile_bump(HIGH_RLIMIT_NOFILE
);
3206 r
= user_config_paths(&config_dirs
);
3208 return log_error_errno(r
, "Failed to initialize configuration directory list: %m");
3210 config_dirs
= strv_split_nulstr(CONF_PATHS_NULSTR("tmpfiles.d"));
3215 if (DEBUG_LOGGING
) {
3216 _cleanup_free_
char *t
= NULL
;
3218 t
= strv_join(config_dirs
, "\n\t");
3220 log_debug("Looking for configuration files in (higher priority first):\n\t%s", t
);
3223 if (arg_cat_config
) {
3224 (void) pager_open(arg_pager_flags
);
3226 return cat_config(config_dirs
, argv
+ optind
);
3233 items
= ordered_hashmap_new(&item_array_hash_ops
);
3234 globs
= ordered_hashmap_new(&item_array_hash_ops
);
3235 if (!items
|| !globs
)
3238 /* If command line arguments are specified along with --replace, read all
3239 * configuration files and insert the positional arguments at the specified
3240 * place. Otherwise, if command line arguments are specified, execute just
3241 * them, and finally, without --replace= or any positional arguments, just
3242 * read configuration and execute it.
3244 if (arg_replace
|| optind
>= argc
)
3245 r
= read_config_files(config_dirs
, argv
+ optind
, &invalid_config
);
3247 r
= parse_arguments(config_dirs
, argv
+ optind
, &invalid_config
);
3251 /* Let's now link up all child/parent relationships */
3252 ORDERED_HASHMAP_FOREACH(a
, items
, iterator
) {
3257 ORDERED_HASHMAP_FOREACH(a
, globs
, iterator
) {
3263 /* If multiple operations are requested, let's first run the remove/clean operations, and only then the create
3264 * operations. i.e. that we first clean out the platform we then build on. */
3265 for (phase
= 0; phase
< _PHASE_MAX
; phase
++) {
3268 if (phase
== PHASE_REMOVE_AND_CLEAN
)
3269 op
= arg_operation
& (OPERATION_REMOVE
|OPERATION_CLEAN
);
3270 else if (phase
== PHASE_CREATE
)
3271 op
= arg_operation
& OPERATION_CREATE
;
3273 assert_not_reached("unexpected phase");
3275 if (op
== 0) /* Nothing requested in this phase */
3278 /* The non-globbing ones usually create things, hence we apply them first */
3279 ORDERED_HASHMAP_FOREACH(a
, items
, iterator
) {
3280 k
= process_item_array(a
, op
);
3281 if (k
< 0 && r
>= 0)
3285 /* The globbing ones usually alter things, hence we apply them second. */
3286 ORDERED_HASHMAP_FOREACH(a
, globs
, iterator
) {
3287 k
= process_item_array(a
, op
);
3288 if (k
< 0 && r
>= 0)
3293 if (ERRNO_IS_RESOURCE(-r
))
3298 return EX_CANTCREAT
;
3302 DEFINE_MAIN_FUNCTION_WITH_POSITIVE_FAILURE(run
);