1 /* SPDX-License-Identifier: LGPL-2.1+ */
13 #include <sys/xattr.h>
21 #include "alloc-util.h"
22 #include "btrfs-util.h"
23 #include "capability-util.h"
24 #include "chattr-util.h"
25 #include "conf-files.h"
28 #include "dirent-util.h"
29 #include "dissect-image.h"
33 #include "format-util.h"
35 #include "glob-util.h"
40 #include "main-func.h"
42 #include "mount-util.h"
43 #include "mountpoint-util.h"
44 #include "offline-passwd.h"
46 #include "parse-util.h"
47 #include "path-lookup.h"
48 #include "path-util.h"
49 #include "pretty-print.h"
50 #include "rlimit-util.h"
52 #include "selinux-util.h"
54 #include "sort-util.h"
55 #include "specifier.h"
56 #include "stat-util.h"
57 #include "stdio-util.h"
58 #include "string-table.h"
59 #include "string-util.h"
61 #include "umask-util.h"
62 #include "user-util.h"
64 /* This reads all files listed in /etc/tmpfiles.d/?*.conf and creates
65 * them in the file system. This is intended to be used to create
66 * properly owned directories beneath /tmp, /var/tmp, /run, which are
67 * volatile and hence need to be recreated on bootup. */
69 typedef enum OperationMask
{
70 OPERATION_CREATE
= 1 << 0,
71 OPERATION_REMOVE
= 1 << 1,
72 OPERATION_CLEAN
= 1 << 2,
75 typedef enum ItemType
{
76 /* These ones take file names */
78 TRUNCATE_FILE
= 'F', /* deprecated: use f+ */
79 CREATE_DIRECTORY
= 'd',
80 TRUNCATE_DIRECTORY
= 'D',
81 CREATE_SUBVOLUME
= 'v',
82 CREATE_SUBVOLUME_INHERIT_QUOTA
= 'q',
83 CREATE_SUBVOLUME_NEW_QUOTA
= 'Q',
86 CREATE_CHAR_DEVICE
= 'c',
87 CREATE_BLOCK_DEVICE
= 'b',
90 /* These ones take globs */
92 EMPTY_DIRECTORY
= 'e',
94 RECURSIVE_SET_XATTR
= 'T',
96 RECURSIVE_SET_ACL
= 'A',
98 RECURSIVE_SET_ATTRIBUTE
= 'H',
100 IGNORE_DIRECTORY_PATH
= 'X',
102 RECURSIVE_REMOVE_PATH
= 'R',
104 RECURSIVE_RELABEL_PATH
= 'Z',
105 ADJUST_MODE
= 'm', /* legacy, 'z' is identical to this */
108 typedef struct Item
{
124 unsigned attribute_value
;
125 unsigned attribute_mask
;
132 bool attribute_set
:1;
134 bool keep_first_level
:1;
136 bool append_or_force
:1;
138 bool allow_failure
:1;
143 typedef struct ItemArray
{
148 struct ItemArray
*parent
;
152 typedef enum DirectoryType
{
160 static bool arg_cat_config
= false;
161 static bool arg_user
= false;
162 static OperationMask arg_operation
= 0;
163 static bool arg_boot
= false;
164 static PagerFlags arg_pager_flags
= 0;
166 static char **arg_include_prefixes
= NULL
;
167 static char **arg_exclude_prefixes
= NULL
;
168 static char *arg_root
= NULL
;
169 static char *arg_image
= NULL
;
170 static char *arg_replace
= NULL
;
172 #define MAX_DEPTH 256
174 static OrderedHashmap
*items
= NULL
, *globs
= NULL
;
175 static Set
*unix_sockets
= NULL
;
177 STATIC_DESTRUCTOR_REGISTER(items
, ordered_hashmap_freep
);
178 STATIC_DESTRUCTOR_REGISTER(globs
, ordered_hashmap_freep
);
179 STATIC_DESTRUCTOR_REGISTER(unix_sockets
, set_free_freep
);
180 STATIC_DESTRUCTOR_REGISTER(arg_include_prefixes
, freep
);
181 STATIC_DESTRUCTOR_REGISTER(arg_exclude_prefixes
, freep
);
182 STATIC_DESTRUCTOR_REGISTER(arg_root
, freep
);
183 STATIC_DESTRUCTOR_REGISTER(arg_image
, 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 { 'l', specifier_short_host_name
, NULL
},
193 { 'v', specifier_kernel_release
, NULL
},
194 { 'a', specifier_architecture
, NULL
},
195 { 'o', specifier_os_id
, NULL
},
196 { 'w', specifier_os_version_id
, NULL
},
197 { 'B', specifier_os_build_id
, NULL
},
198 { 'W', specifier_os_variant_id
, NULL
},
200 { 'g', specifier_group_name
, NULL
},
201 { 'G', specifier_group_id
, NULL
},
202 { 'U', specifier_user_id
, NULL
},
203 { 'u', specifier_user_name
, NULL
},
204 { 'h', specifier_user_home
, NULL
},
206 { 't', specifier_directory
, UINT_TO_PTR(DIRECTORY_RUNTIME
) },
207 { 'S', specifier_directory
, UINT_TO_PTR(DIRECTORY_STATE
) },
208 { 'C', specifier_directory
, UINT_TO_PTR(DIRECTORY_CACHE
) },
209 { 'L', specifier_directory
, UINT_TO_PTR(DIRECTORY_LOGS
) },
210 { 'T', specifier_tmp_dir
, NULL
},
211 { 'V', specifier_var_tmp_dir
, NULL
},
215 static int specifier_machine_id_safe(char specifier
, const void *data
, const void *userdata
, char **ret
) {
218 /* If /etc/machine_id is missing or empty (e.g. in a chroot environment)
219 * return a recognizable error so that the caller can skip the rule
222 r
= specifier_machine_id(specifier
, data
, userdata
, ret
);
223 if (IN_SET(r
, -ENOENT
, -ENOMEDIUM
))
229 static int specifier_directory(char specifier
, const void *data
, const void *userdata
, char **ret
) {
235 static const struct table_entry paths_system
[] = {
236 [DIRECTORY_RUNTIME
] = { SD_PATH_SYSTEM_RUNTIME
},
237 [DIRECTORY_STATE
] = { SD_PATH_SYSTEM_STATE_PRIVATE
},
238 [DIRECTORY_CACHE
] = { SD_PATH_SYSTEM_STATE_CACHE
},
239 [DIRECTORY_LOGS
] = { SD_PATH_SYSTEM_STATE_LOGS
},
242 static const struct table_entry paths_user
[] = {
243 [DIRECTORY_RUNTIME
] = { SD_PATH_USER_RUNTIME
},
244 [DIRECTORY_STATE
] = { SD_PATH_USER_CONFIGURATION
},
245 [DIRECTORY_CACHE
] = { SD_PATH_USER_STATE_CACHE
},
246 [DIRECTORY_LOGS
] = { SD_PATH_USER_CONFIGURATION
, "log" },
250 const struct table_entry
*paths
;
252 assert_cc(ELEMENTSOF(paths_system
) == ELEMENTSOF(paths_user
));
253 paths
= arg_user
? paths_user
: paths_system
;
255 i
= PTR_TO_UINT(data
);
256 assert(i
< ELEMENTSOF(paths_system
));
258 return sd_path_lookup(paths
[i
].type
, paths
[i
].suffix
, ret
);
261 static int log_unresolvable_specifier(const char *filename
, unsigned line
) {
262 static bool notified
= false;
264 /* In system mode, this is called when /etc is not fully initialized (e.g.
265 * in a chroot environment) where some specifiers are unresolvable. In user
266 * mode, this is called when some variables are not defined. These cases are
267 * not considered as an error so log at LOG_NOTICE only for the first time
268 * and then downgrade this to LOG_DEBUG for the rest. */
271 notified
? LOG_DEBUG
: LOG_NOTICE
,
273 "Failed to resolve specifier: %s, skipping",
274 arg_user
? "Required $XDG_... variable not defined" : "uninitialized /etc detected");
277 log_notice("All rules containing unresolvable specifiers will be skipped.");
283 static int user_config_paths(char*** ret
) {
284 _cleanup_strv_free_
char **config_dirs
= NULL
, **data_dirs
= NULL
;
285 _cleanup_free_
char *persistent_config
= NULL
, *runtime_config
= NULL
, *data_home
= NULL
;
286 _cleanup_strv_free_
char **res
= NULL
;
289 r
= xdg_user_dirs(&config_dirs
, &data_dirs
);
293 r
= xdg_user_config_dir(&persistent_config
, "/user-tmpfiles.d");
294 if (r
< 0 && r
!= -ENXIO
)
297 r
= xdg_user_runtime_dir(&runtime_config
, "/user-tmpfiles.d");
298 if (r
< 0 && r
!= -ENXIO
)
301 r
= xdg_user_data_dir(&data_home
, "/user-tmpfiles.d");
302 if (r
< 0 && r
!= -ENXIO
)
305 r
= strv_extend_strv_concat(&res
, config_dirs
, "/user-tmpfiles.d");
309 r
= strv_extend(&res
, persistent_config
);
313 r
= strv_extend(&res
, runtime_config
);
317 r
= strv_extend(&res
, data_home
);
321 r
= strv_extend_strv_concat(&res
, data_dirs
, "/user-tmpfiles.d");
325 r
= path_strv_make_absolute_cwd(res
);
329 *ret
= TAKE_PTR(res
);
333 static bool needs_glob(ItemType t
) {
337 IGNORE_DIRECTORY_PATH
,
339 RECURSIVE_REMOVE_PATH
,
343 RECURSIVE_RELABEL_PATH
,
349 RECURSIVE_SET_ATTRIBUTE
);
352 static bool takes_ownership(ItemType t
) {
360 CREATE_SUBVOLUME_INHERIT_QUOTA
,
361 CREATE_SUBVOLUME_NEW_QUOTA
,
369 IGNORE_DIRECTORY_PATH
,
371 RECURSIVE_REMOVE_PATH
);
374 static struct Item
* find_glob(OrderedHashmap
*h
, const char *match
) {
378 ORDERED_HASHMAP_FOREACH(j
, h
, i
) {
381 for (n
= 0; n
< j
->n_items
; n
++) {
382 Item
*item
= j
->items
+ n
;
384 if (fnmatch(item
->path
, match
, FNM_PATHNAME
|FNM_PERIOD
) == 0)
392 static int load_unix_sockets(void) {
393 _cleanup_set_free_free_ Set
*sockets
= NULL
;
394 _cleanup_fclose_
FILE *f
= NULL
;
400 /* We maintain a cache of the sockets we found in /proc/net/unix to speed things up a little. */
402 sockets
= set_new(&path_hash_ops
);
406 f
= fopen("/proc/net/unix", "re");
408 return log_full_errno(errno
== ENOENT
? LOG_DEBUG
: LOG_WARNING
, errno
,
409 "Failed to open /proc/net/unix, ignoring: %m");
412 r
= read_line(f
, LONG_LINE_MAX
, NULL
);
414 return log_warning_errno(r
, "Failed to skip /proc/net/unix header line: %m");
416 return log_warning_errno(SYNTHETIC_ERRNO(EIO
), "Premature end of file reading /proc/net/unix.");
419 _cleanup_free_
char *line
= NULL
, *s
= NULL
;
422 r
= read_line(f
, LONG_LINE_MAX
, &line
);
424 return log_warning_errno(r
, "Failed to read /proc/net/unix line, ignoring: %m");
425 if (r
== 0) /* EOF */
428 p
= strchr(line
, ':');
436 p
+= strspn(p
, WHITESPACE
);
437 p
+= strcspn(p
, WHITESPACE
); /* skip one more word */
438 p
+= strspn(p
, WHITESPACE
);
447 path_simplify(s
, false);
449 r
= set_consume(sockets
, s
);
453 return log_warning_errno(r
, "Failed to add AF_UNIX socket to set, ignoring: %m");
458 unix_sockets
= TAKE_PTR(sockets
);
462 static bool unix_socket_alive(const char *fn
) {
465 if (load_unix_sockets() < 0)
466 return true; /* We don't know, so assume yes */
468 return !!set_get(unix_sockets
, (char*) fn
);
471 static DIR* xopendirat_nomod(int dirfd
, const char *path
) {
474 dir
= xopendirat(dirfd
, path
, O_NOFOLLOW
|O_NOATIME
);
478 log_debug_errno(errno
, "Cannot open %sdirectory \"%s\": %m", dirfd
== AT_FDCWD
? "" : "sub", path
);
482 dir
= xopendirat(dirfd
, path
, O_NOFOLLOW
);
484 log_debug_errno(errno
, "Cannot open %sdirectory \"%s\": %m", dirfd
== AT_FDCWD
? "" : "sub", path
);
489 static DIR* opendir_nomod(const char *path
) {
490 return xopendirat_nomod(AT_FDCWD
, path
);
493 static int dir_cleanup(
497 const struct stat
*ds
,
502 bool keep_this_level
) {
505 bool deleted
= false;
508 FOREACH_DIRENT_ALL(dent
, d
, break) {
511 _cleanup_free_
char *sub_path
= NULL
;
513 if (dot_or_dot_dot(dent
->d_name
))
516 if (fstatat(dirfd(d
), dent
->d_name
, &s
, AT_SYMLINK_NOFOLLOW
) < 0) {
520 /* FUSE, NFS mounts, SELinux might return EACCES */
521 r
= log_full_errno(errno
== EACCES
? LOG_DEBUG
: LOG_ERR
, errno
,
522 "stat(%s/%s) failed: %m", p
, dent
->d_name
);
526 /* Stay on the same filesystem */
527 if (s
.st_dev
!= rootdev
) {
528 log_debug("Ignoring \"%s/%s\": different filesystem.", p
, dent
->d_name
);
532 /* Try to detect bind mounts of the same filesystem instance; they
533 * do not differ in device major/minors. This type of query is not
534 * supported on all kernels or filesystem types though. */
535 if (S_ISDIR(s
.st_mode
)) {
538 q
= fd_is_mount_point(dirfd(d
), dent
->d_name
, 0);
540 log_debug_errno(q
, "Failed to determine whether \"%s/%s\" is a mount point, ignoring: %m", p
, dent
->d_name
);
542 log_debug("Ignoring \"%s/%s\": different mount of the same filesystem.", p
, dent
->d_name
);
547 sub_path
= path_join(p
, dent
->d_name
);
553 /* Is there an item configured for this path? */
554 if (ordered_hashmap_get(items
, sub_path
)) {
555 log_debug("Ignoring \"%s\": a separate entry exists.", sub_path
);
559 if (find_glob(globs
, sub_path
)) {
560 log_debug("Ignoring \"%s\": a separate glob exists.", sub_path
);
564 if (S_ISDIR(s
.st_mode
)) {
565 _cleanup_closedir_
DIR *sub_dir
= NULL
;
568 streq(dent
->d_name
, "lost+found") &&
570 log_debug("Ignoring directory \"%s\".", sub_path
);
575 log_warning("Reached max depth on \"%s\".", sub_path
);
579 sub_dir
= xopendirat_nomod(dirfd(d
), dent
->d_name
);
582 r
= log_warning_errno(errno
, "Opening directory \"%s\" failed, ignoring: %m", sub_path
);
587 if (flock(dirfd(sub_dir
), LOCK_EX
|LOCK_NB
) < 0) {
588 log_debug_errno(errno
, "Couldn't acquire shared BSD lock on directory \"%s\", skipping: %m", p
);
592 q
= dir_cleanup(i
, sub_path
, sub_dir
, &s
, cutoff
, rootdev
, false, maxdepth
-1, false);
597 /* Note: if you are wondering why we don't support the sticky bit for excluding
598 * directories from cleaning like we do it for other file system objects: well, the
599 * sticky bit already has a meaning for directories, so we don't want to overload
602 if (keep_this_level
) {
603 log_debug("Keeping directory \"%s\".", sub_path
);
607 /* Ignore ctime, we change it when deleting */
608 age
= timespec_load(&s
.st_mtim
);
610 char a
[FORMAT_TIMESTAMP_MAX
];
611 /* Follows spelling in stat(1). */
612 log_debug("Directory \"%s\": modify time %s is too new.",
614 format_timestamp_us(a
, sizeof(a
), age
));
618 age
= timespec_load(&s
.st_atim
);
620 char a
[FORMAT_TIMESTAMP_MAX
];
621 log_debug("Directory \"%s\": access time %s is too new.",
623 format_timestamp_us(a
, sizeof(a
), age
));
627 log_debug("Removing directory \"%s\".", sub_path
);
628 if (unlinkat(dirfd(d
), dent
->d_name
, AT_REMOVEDIR
) < 0)
629 if (!IN_SET(errno
, ENOENT
, ENOTEMPTY
))
630 r
= log_warning_errno(errno
, "Failed to remove directory \"%s\", ignoring: %m", sub_path
);
633 /* Skip files for which the sticky bit is set. These are semantics we define, and are
634 * unknown elsewhere. See XDG_RUNTIME_DIR specification for details. */
635 if (s
.st_mode
& S_ISVTX
) {
636 log_debug("Skipping \"%s\": sticky bit set.", sub_path
);
641 S_ISREG(s
.st_mode
) &&
643 STR_IN_SET(dent
->d_name
,
647 log_debug("Skipping \"%s\".", sub_path
);
651 /* Ignore sockets that are listed in /proc/net/unix */
652 if (S_ISSOCK(s
.st_mode
) && unix_socket_alive(sub_path
)) {
653 log_debug("Skipping \"%s\": live socket.", sub_path
);
657 /* Ignore device nodes */
658 if (S_ISCHR(s
.st_mode
) || S_ISBLK(s
.st_mode
)) {
659 log_debug("Skipping \"%s\": a device.", sub_path
);
663 /* Keep files on this level around if this is requested */
664 if (keep_this_level
) {
665 log_debug("Keeping \"%s\".", sub_path
);
669 age
= timespec_load(&s
.st_mtim
);
671 char a
[FORMAT_TIMESTAMP_MAX
];
672 /* Follows spelling in stat(1). */
673 log_debug("File \"%s\": modify time %s is too new.",
675 format_timestamp_us(a
, sizeof(a
), age
));
679 age
= timespec_load(&s
.st_atim
);
681 char a
[FORMAT_TIMESTAMP_MAX
];
682 log_debug("File \"%s\": access time %s is too new.",
684 format_timestamp_us(a
, sizeof(a
), age
));
688 age
= timespec_load(&s
.st_ctim
);
690 char a
[FORMAT_TIMESTAMP_MAX
];
691 log_debug("File \"%s\": change time %s is too new.",
693 format_timestamp_us(a
, sizeof(a
), age
));
697 log_debug("Removing \"%s\".", sub_path
);
698 if (unlinkat(dirfd(d
), dent
->d_name
, 0) < 0)
700 r
= log_warning_errno(errno
, "Failed to remove \"%s\", ignoring: %m", sub_path
);
708 char a
[FORMAT_TIMESTAMP_MAX
], b
[FORMAT_TIMESTAMP_MAX
];
711 age1
= timespec_load(&ds
->st_atim
);
712 age2
= timespec_load(&ds
->st_mtim
);
714 log_debug("Restoring access and modification time on \"%s\": %s, %s",
716 format_timestamp_us(a
, sizeof(a
), age1
),
717 format_timestamp_us(b
, sizeof(b
), age2
));
719 /* Restore original directory timestamps */
720 if (futimens(dirfd(d
), (struct timespec
[]) {
723 log_warning_errno(errno
, "Failed to revert timestamps of '%s', ignoring: %m", p
);
729 static bool dangerous_hardlinks(void) {
730 _cleanup_free_
char *value
= NULL
;
731 static int cached
= -1;
734 /* Check whether the fs.protected_hardlinks sysctl is on. If we can't determine it we assume its off, as that's
735 * what the upstream default is. */
740 r
= read_one_line_file("/proc/sys/fs/protected_hardlinks", &value
);
742 log_debug_errno(r
, "Failed to read fs.protected_hardlinks sysctl: %m");
746 r
= parse_boolean(value
);
748 log_debug_errno(r
, "Failed to parse fs.protected_hardlinks sysctl: %m");
756 static bool hardlink_vulnerable(const struct stat
*st
) {
759 return !S_ISDIR(st
->st_mode
) && st
->st_nlink
> 1 && dangerous_hardlinks();
762 static mode_t
process_mask_perms(mode_t mode
, mode_t current
) {
764 if ((current
& 0111) == 0)
766 if ((current
& 0222) == 0)
768 if ((current
& 0444) == 0)
770 if (!S_ISDIR(current
))
771 mode
&= ~07000; /* remove sticky/sgid/suid bit, unless directory */
776 static int fd_set_perms(Item
*i
, int fd
, const char *path
, const struct stat
*st
) {
785 if (!i
->mode_set
&& !i
->uid_set
&& !i
->gid_set
)
789 if (fstat(fd
, &stbuf
) < 0)
790 return log_error_errno(errno
, "fstat(%s) failed: %m", path
);
794 if (hardlink_vulnerable(st
))
795 return log_error_errno(SYNTHETIC_ERRNO(EPERM
),
796 "Refusing to set permissions on hardlinked file %s while the fs.protected_hardlinks sysctl is turned off.",
799 /* Do we need a chown()? */
801 (i
->uid_set
&& i
->uid
!= st
->st_uid
) ||
802 (i
->gid_set
&& i
->gid
!= st
->st_gid
);
804 /* Calculate the mode to apply */
805 new_mode
= i
->mode_set
? (i
->mask_perms
?
806 process_mask_perms(i
->mode
, st
->st_mode
) :
808 (st
->st_mode
& 07777);
810 if (i
->mode_set
&& do_chown
) {
811 /* Before we issue the chmod() let's reduce the access mode to the common bits of the old and
812 * the new mode. That way there's no time window where the file exists under the old owner
813 * with more than the old access modes — and not under the new owner with more than the new
814 * access modes either. */
816 if (S_ISLNK(st
->st_mode
))
817 log_debug("Skipping temporary mode fix for symlink %s.", path
);
819 mode_t m
= new_mode
& st
->st_mode
; /* Mask new mode by old mode */
821 if (((m
^ st
->st_mode
) & 07777) == 0)
822 log_debug("\"%s\" matches temporary mode %o already.", path
, m
);
824 log_debug("Temporarily changing \"%s\" to mode %o.", path
, m
);
825 if (fchmod_opath(fd
, m
) < 0)
826 return log_error_errno(errno
, "fchmod() of %s failed: %m", path
);
832 log_debug("Changing \"%s\" to owner "UID_FMT
":"GID_FMT
,
834 i
->uid_set
? i
->uid
: UID_INVALID
,
835 i
->gid_set
? i
->gid
: GID_INVALID
);
839 i
->uid_set
? i
->uid
: UID_INVALID
,
840 i
->gid_set
? i
->gid
: GID_INVALID
,
842 return log_error_errno(errno
, "fchownat() of %s failed: %m", path
);
845 /* Now, apply the final mode. We do this in two cases: when the user set a mode explicitly, or after a
846 * chown(), since chown()'s mangle the access mode in regards to sgid/suid in some conditions. */
847 if (i
->mode_set
|| do_chown
) {
848 if (S_ISLNK(st
->st_mode
))
849 log_debug("Skipping mode fix for symlink %s.", path
);
851 /* Check if the chmod() is unnecessary. Note that if we did a chown() before we always
852 * chmod() here again, since it might have mangled the bits. */
853 if (!do_chown
&& ((new_mode
^ st
->st_mode
) & 07777) == 0)
854 log_debug("\"%s\" matches mode %o already.", path
, new_mode
);
856 log_debug("Changing \"%s\" to mode %o.", path
, new_mode
);
857 if (fchmod_opath(fd
, new_mode
) < 0)
858 return log_error_errno(errno
, "fchmod() of %s failed: %m", path
);
864 return label_fix(path
, 0);
867 static int path_open_parent_safe(const char *path
) {
868 _cleanup_free_
char *dn
= NULL
;
871 if (path_equal(path
, "/") || !path_is_normalized(path
))
872 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
873 "Failed to open parent of '%s': invalid path.",
876 dn
= dirname_malloc(path
);
880 r
= chase_symlinks(dn
, arg_root
, CHASE_SAFE
|CHASE_WARN
, NULL
, &fd
);
881 if (r
< 0 && r
!= -ENOLINK
)
882 return log_error_errno(r
, "Failed to validate path %s: %m", path
);
884 return r
< 0 ? r
: fd
;
887 static int path_open_safe(const char *path
) {
890 /* path_open_safe() returns a file descriptor opened with O_PATH after
891 * verifying that the path doesn't contain unsafe transitions, except
892 * for its final component as the function does not follow symlink. */
896 if (!path_is_normalized(path
))
897 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
898 "Failed to open invalid path '%s'.",
901 r
= chase_symlinks(path
, arg_root
, CHASE_SAFE
|CHASE_WARN
|CHASE_NOFOLLOW
, NULL
, &fd
);
902 if (r
< 0 && r
!= -ENOLINK
)
903 return log_error_errno(r
, "Failed to validate path %s: %m", path
);
905 return r
< 0 ? r
: fd
;
908 static int path_set_perms(Item
*i
, const char *path
) {
909 _cleanup_close_
int fd
= -1;
914 fd
= path_open_safe(path
);
918 return fd_set_perms(i
, fd
, path
, NULL
);
921 static int parse_xattrs_from_arg(Item
*i
) {
931 _cleanup_free_
char *name
= NULL
, *value
= NULL
, *xattr
= NULL
;
933 r
= extract_first_word(&p
, &xattr
, NULL
, EXTRACT_UNQUOTE
|EXTRACT_CUNESCAPE
);
935 log_warning_errno(r
, "Failed to parse extended attribute '%s', ignoring: %m", p
);
939 r
= split_pair(xattr
, "=", &name
, &value
);
941 log_warning_errno(r
, "Failed to parse extended attribute, ignoring: %s", xattr
);
945 if (isempty(name
) || isempty(value
)) {
946 log_warning("Malformed extended attribute found, ignoring: %s", xattr
);
950 if (strv_push_pair(&i
->xattrs
, name
, value
) < 0)
959 static int fd_set_xattrs(Item
*i
, int fd
, const char *path
, const struct stat
*st
) {
960 char procfs_path
[STRLEN("/proc/self/fd/") + DECIMAL_STR_MAX(int)];
961 char **name
, **value
;
967 xsprintf(procfs_path
, "/proc/self/fd/%i", fd
);
969 STRV_FOREACH_PAIR(name
, value
, i
->xattrs
) {
970 log_debug("Setting extended attribute '%s=%s' on %s.", *name
, *value
, path
);
971 if (setxattr(procfs_path
, *name
, *value
, strlen(*value
), 0) < 0)
972 return log_error_errno(errno
, "Setting extended attribute %s=%s on %s failed: %m",
973 *name
, *value
, path
);
978 static int path_set_xattrs(Item
*i
, const char *path
) {
979 _cleanup_close_
int fd
= -1;
984 fd
= path_open_safe(path
);
988 return fd_set_xattrs(i
, fd
, path
, NULL
);
991 static int parse_acls_from_arg(Item
*item
) {
997 /* If append_or_force (= modify) is set, we will not modify the acl
998 * afterwards, so the mask can be added now if necessary. */
1000 r
= parse_acl(item
->argument
, &item
->acl_access
, &item
->acl_default
, !item
->append_or_force
);
1002 log_warning_errno(r
, "Failed to parse ACL \"%s\": %m. Ignoring", item
->argument
);
1004 log_warning_errno(SYNTHETIC_ERRNO(ENOSYS
), "ACLs are not supported. Ignoring");
1011 static int path_set_acl(const char *path
, const char *pretty
, acl_type_t type
, acl_t acl
, bool modify
) {
1012 _cleanup_(acl_free_charpp
) char *t
= NULL
;
1013 _cleanup_(acl_freep
) acl_t dup
= NULL
;
1016 /* Returns 0 for success, positive error if already warned,
1017 * negative error otherwise. */
1020 r
= acls_for_file(path
, type
, acl
, &dup
);
1024 r
= calc_acl_mask_if_needed(&dup
);
1032 /* the mask was already added earlier if needed */
1035 r
= add_base_acls_if_needed(&dup
, path
);
1039 t
= acl_to_any_text(dup
, NULL
, ',', TEXT_ABBREVIATE
);
1040 log_debug("Setting %s ACL %s on %s.",
1041 type
== ACL_TYPE_ACCESS
? "access" : "default",
1044 r
= acl_set_file(path
, type
, dup
);
1046 /* Return positive to indicate we already warned */
1047 return -log_error_errno(errno
,
1048 "Setting %s ACL \"%s\" on %s failed: %m",
1049 type
== ACL_TYPE_ACCESS
? "access" : "default",
1056 static int fd_set_acls(Item
*item
, int fd
, const char *path
, const struct stat
*st
) {
1059 char procfs_path
[STRLEN("/proc/self/fd/") + DECIMAL_STR_MAX(int)];
1067 if (fstat(fd
, &stbuf
) < 0)
1068 return log_error_errno(errno
, "fstat(%s) failed: %m", path
);
1072 if (hardlink_vulnerable(st
))
1073 return log_error_errno(SYNTHETIC_ERRNO(EPERM
),
1074 "Refusing to set ACLs on hardlinked file %s while the fs.protected_hardlinks sysctl is turned off.",
1077 if (S_ISLNK(st
->st_mode
)) {
1078 log_debug("Skipping ACL fix for symlink %s.", path
);
1082 xsprintf(procfs_path
, "/proc/self/fd/%i", fd
);
1084 if (item
->acl_access
)
1085 r
= path_set_acl(procfs_path
, path
, ACL_TYPE_ACCESS
, item
->acl_access
, item
->append_or_force
);
1087 /* set only default acls to folders */
1088 if (r
== 0 && item
->acl_default
&& S_ISDIR(st
->st_mode
))
1089 r
= path_set_acl(procfs_path
, path
, ACL_TYPE_DEFAULT
, item
->acl_default
, item
->append_or_force
);
1092 return -r
; /* already warned */
1094 /* The above procfs paths don't work if /proc is not mounted. */
1095 if (r
== -ENOENT
&& proc_mounted() == 0)
1098 if (r
== -EOPNOTSUPP
) {
1099 log_debug_errno(r
, "ACLs not supported by file system at %s", path
);
1103 return log_error_errno(r
, "ACL operation on \"%s\" failed: %m", path
);
1108 static int path_set_acls(Item
*item
, const char *path
) {
1111 _cleanup_close_
int fd
= -1;
1116 fd
= path_open_safe(path
);
1120 r
= fd_set_acls(item
, fd
, path
, NULL
);
1125 static int parse_attribute_from_arg(Item
*item
) {
1127 static const struct {
1131 { 'A', FS_NOATIME_FL
}, /* do not update atime */
1132 { 'S', FS_SYNC_FL
}, /* Synchronous updates */
1133 { 'D', FS_DIRSYNC_FL
}, /* dirsync behaviour (directories only) */
1134 { 'a', FS_APPEND_FL
}, /* writes to file may only append */
1135 { 'c', FS_COMPR_FL
}, /* Compress file */
1136 { 'd', FS_NODUMP_FL
}, /* do not dump file */
1137 { 'e', FS_EXTENT_FL
}, /* Extents */
1138 { 'i', FS_IMMUTABLE_FL
}, /* Immutable file */
1139 { 'j', FS_JOURNAL_DATA_FL
}, /* Reserved for ext3 */
1140 { 's', FS_SECRM_FL
}, /* Secure deletion */
1141 { 'u', FS_UNRM_FL
}, /* Undelete */
1142 { 't', FS_NOTAIL_FL
}, /* file tail should not be merged */
1143 { 'T', FS_TOPDIR_FL
}, /* Top of directory hierarchies */
1144 { 'C', FS_NOCOW_FL
}, /* Do not cow file */
1145 { 'P', FS_PROJINHERIT_FL
}, /* Inherit the quota project ID */
1154 unsigned value
= 0, mask
= 0;
1164 } else if (*p
== '-') {
1167 } else if (*p
== '=') {
1173 if (isempty(p
) && mode
!= MODE_SET
)
1174 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
1175 "Setting file attribute on '%s' needs an attribute specification.",
1178 for (; p
&& *p
; p
++) {
1181 for (i
= 0; i
< ELEMENTSOF(attributes
); i
++)
1182 if (*p
== attributes
[i
].character
)
1185 if (i
>= ELEMENTSOF(attributes
))
1186 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
1187 "Unknown file attribute '%c' on '%s'.",
1190 v
= attributes
[i
].value
;
1192 SET_FLAG(value
, v
, IN_SET(mode
, MODE_ADD
, MODE_SET
));
1197 if (mode
== MODE_SET
)
1198 mask
|= CHATTR_ALL_FL
;
1202 item
->attribute_mask
= mask
;
1203 item
->attribute_value
= value
;
1204 item
->attribute_set
= true;
1209 static int fd_set_attribute(Item
*item
, int fd
, const char *path
, const struct stat
*st
) {
1210 _cleanup_close_
int procfs_fd
= -1;
1219 if (!item
->attribute_set
|| item
->attribute_mask
== 0)
1223 if (fstat(fd
, &stbuf
) < 0)
1224 return log_error_errno(errno
, "fstat(%s) failed: %m", path
);
1228 /* Issuing the file attribute ioctls on device nodes is not
1229 * safe, as that will be delivered to the drivers, not the
1230 * file system containing the device node. */
1231 if (!S_ISREG(st
->st_mode
) && !S_ISDIR(st
->st_mode
))
1232 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
1233 "Setting file flags is only supported on regular files and directories, cannot set on '%s'.",
1236 f
= item
->attribute_value
& item
->attribute_mask
;
1238 /* Mask away directory-specific flags */
1239 if (!S_ISDIR(st
->st_mode
))
1240 f
&= ~FS_DIRSYNC_FL
;
1242 procfs_fd
= fd_reopen(fd
, O_RDONLY
|O_CLOEXEC
|O_NOATIME
);
1244 return log_error_errno(procfs_fd
, "Failed to re-open '%s': %m", path
);
1246 r
= chattr_fd(procfs_fd
, f
, item
->attribute_mask
, NULL
);
1248 log_full_errno(IN_SET(r
, -ENOTTY
, -EOPNOTSUPP
) ? LOG_DEBUG
: LOG_WARNING
,
1250 "Cannot set file attribute for '%s', value=0x%08x, mask=0x%08x, ignoring: %m",
1251 path
, item
->attribute_value
, item
->attribute_mask
);
1256 static int path_set_attribute(Item
*item
, const char *path
) {
1257 _cleanup_close_
int fd
= -1;
1259 if (!item
->attribute_set
|| item
->attribute_mask
== 0)
1262 fd
= path_open_safe(path
);
1266 return fd_set_attribute(item
, fd
, path
, NULL
);
1269 static int write_one_file(Item
*i
, const char *path
) {
1270 _cleanup_close_
int fd
= -1, dir_fd
= -1;
1276 assert(i
->argument
);
1277 assert(i
->type
== WRITE_FILE
);
1279 /* Validate the path and keep the fd on the directory for opening the
1280 * file so we're sure that it can't be changed behind our back. */
1281 dir_fd
= path_open_parent_safe(path
);
1285 bn
= basename(path
);
1287 /* Follows symlinks */
1288 fd
= openat(dir_fd
, bn
,
1289 O_NONBLOCK
|O_CLOEXEC
|O_WRONLY
|O_NOCTTY
|(i
->append_or_force
? O_APPEND
: 0),
1292 if (errno
== ENOENT
) {
1293 log_debug_errno(errno
, "Not writing missing file \"%s\": %m", path
);
1297 if (i
->allow_failure
)
1298 return log_debug_errno(errno
, "Failed to open file \"%s\", ignoring: %m", path
);
1300 return log_error_errno(errno
, "Failed to open file \"%s\": %m", path
);
1303 /* 'w' is allowed to write into any kind of files. */
1304 log_debug("Writing to \"%s\".", path
);
1306 r
= loop_write(fd
, i
->argument
, strlen(i
->argument
), false);
1308 return log_error_errno(r
, "Failed to write file \"%s\": %m", path
);
1310 return fd_set_perms(i
, fd
, path
, NULL
);
1313 static int create_file(Item
*i
, const char *path
) {
1314 _cleanup_close_
int fd
= -1, dir_fd
= -1;
1315 struct stat stbuf
, *st
= NULL
;
1321 assert(i
->type
== CREATE_FILE
);
1323 /* 'f' operates on regular files exclusively. */
1325 /* Validate the path and keep the fd on the directory for opening the
1326 * file so we're sure that it can't be changed behind our back. */
1327 dir_fd
= path_open_parent_safe(path
);
1331 bn
= basename(path
);
1333 RUN_WITH_UMASK(0000) {
1334 mac_selinux_create_file_prepare(path
, S_IFREG
);
1335 fd
= openat(dir_fd
, bn
, O_CREAT
|O_EXCL
|O_NOFOLLOW
|O_NONBLOCK
|O_CLOEXEC
|O_WRONLY
|O_NOCTTY
, i
->mode
);
1336 mac_selinux_create_file_clear();
1340 /* Even on a read-only filesystem, open(2) returns EEXIST if the
1341 * file already exists. It returns EROFS only if it needs to
1342 * create the file. */
1343 if (errno
!= EEXIST
)
1344 return log_error_errno(errno
, "Failed to create file %s: %m", path
);
1346 /* Re-open the file. At that point it must exist since open(2)
1347 * failed with EEXIST. We still need to check if the perms/mode
1348 * need to be changed. For read-only filesystems, we let
1349 * fd_set_perms() report the error if the perms need to be
1351 fd
= openat(dir_fd
, bn
, O_NOFOLLOW
|O_CLOEXEC
|O_PATH
, i
->mode
);
1353 return log_error_errno(errno
, "Failed to re-open file %s: %m", path
);
1355 if (fstat(fd
, &stbuf
) < 0)
1356 return log_error_errno(errno
, "stat(%s) failed: %m", path
);
1358 if (!S_ISREG(stbuf
.st_mode
)) {
1359 log_error("%s exists and is not a regular file.", path
);
1366 log_debug("\"%s\" has been created.", path
);
1369 log_debug("Writing to \"%s\".", path
);
1371 r
= loop_write(fd
, i
->argument
, strlen(i
->argument
), false);
1373 return log_error_errno(r
, "Failed to write file \"%s\": %m", path
);
1377 return fd_set_perms(i
, fd
, path
, st
);
1380 static int truncate_file(Item
*i
, const char *path
) {
1381 _cleanup_close_
int fd
= -1, dir_fd
= -1;
1382 struct stat stbuf
, *st
= NULL
;
1389 assert(i
->type
== TRUNCATE_FILE
|| (i
->type
== CREATE_FILE
&& i
->append_or_force
));
1391 /* We want to operate on regular file exclusively especially since
1392 * O_TRUNC is unspecified if the file is neither a regular file nor a
1393 * fifo nor a terminal device. Therefore we first open the file and make
1394 * sure it's a regular one before truncating it. */
1396 /* Validate the path and keep the fd on the directory for opening the
1397 * file so we're sure that it can't be changed behind our back. */
1398 dir_fd
= path_open_parent_safe(path
);
1402 bn
= basename(path
);
1404 RUN_WITH_UMASK(0000) {
1405 mac_selinux_create_file_prepare(path
, S_IFREG
);
1406 fd
= openat(dir_fd
, bn
, O_CREAT
|O_NOFOLLOW
|O_NONBLOCK
|O_CLOEXEC
|O_WRONLY
|O_NOCTTY
, i
->mode
);
1407 mac_selinux_create_file_clear();
1412 return log_error_errno(errno
, "Failed to open/create file %s: %m", path
);
1414 /* On a read-only filesystem, we don't want to fail if the
1415 * target is already empty and the perms are set. So we still
1416 * proceed with the sanity checks and let the remaining
1417 * operations fail with EROFS if they try to modify the target
1420 fd
= openat(dir_fd
, bn
, O_NOFOLLOW
|O_CLOEXEC
|O_PATH
, i
->mode
);
1422 if (errno
== ENOENT
) {
1423 log_error("Cannot create file %s on a read-only file system.", path
);
1427 return log_error_errno(errno
, "Failed to re-open file %s: %m", path
);
1433 if (fstat(fd
, &stbuf
) < 0)
1434 return log_error_errno(errno
, "stat(%s) failed: %m", path
);
1436 if (!S_ISREG(stbuf
.st_mode
)) {
1437 log_error("%s exists and is not a regular file.", path
);
1441 if (stbuf
.st_size
> 0) {
1442 if (ftruncate(fd
, 0) < 0) {
1443 r
= erofs
? -EROFS
: -errno
;
1444 return log_error_errno(r
, "Failed to truncate file %s: %m", path
);
1449 log_debug("\"%s\" has been created.", path
);
1452 log_debug("Writing to \"%s\".", path
);
1454 r
= loop_write(fd
, i
->argument
, strlen(i
->argument
), false);
1456 r
= erofs
? -EROFS
: r
;
1457 return log_error_errno(r
, "Failed to write file %s: %m", path
);
1461 return fd_set_perms(i
, fd
, path
, st
);
1464 static int copy_files(Item
*i
) {
1465 _cleanup_close_
int dfd
= -1, fd
= -1;
1469 log_debug("Copying tree \"%s\" to \"%s\".", i
->argument
, i
->path
);
1471 bn
= basename(i
->path
);
1473 /* Validate the path and use the returned directory fd for copying the
1474 * target so we're sure that the path can't be changed behind our
1476 dfd
= path_open_parent_safe(i
->path
);
1480 r
= copy_tree_at(AT_FDCWD
, i
->argument
,
1482 i
->uid_set
? i
->uid
: UID_INVALID
,
1483 i
->gid_set
? i
->gid
: GID_INVALID
,
1484 COPY_REFLINK
| COPY_MERGE_EMPTY
| COPY_MAC_CREATE
);
1488 /* If the target already exists on read-only filesystems, trying
1489 * to create the target will not fail with EEXIST but with
1491 if (r
== -EROFS
&& faccessat(dfd
, bn
, F_OK
, AT_SYMLINK_NOFOLLOW
) == 0)
1495 return log_error_errno(r
, "Failed to copy files to %s: %m", i
->path
);
1497 if (stat(i
->argument
, &a
) < 0)
1498 return log_error_errno(errno
, "stat(%s) failed: %m", i
->argument
);
1500 if (fstatat(dfd
, bn
, &b
, AT_SYMLINK_NOFOLLOW
) < 0)
1501 return log_error_errno(errno
, "stat(%s) failed: %m", i
->path
);
1503 if ((a
.st_mode
^ b
.st_mode
) & S_IFMT
) {
1504 log_debug("Can't copy to %s, file exists already and is of different type", i
->path
);
1509 fd
= openat(dfd
, bn
, O_NOFOLLOW
|O_CLOEXEC
|O_PATH
);
1511 return log_error_errno(errno
, "Failed to openat(%s): %m", i
->path
);
1513 return fd_set_perms(i
, fd
, i
->path
, NULL
);
1521 _CREATION_MODE_INVALID
= -1
1524 static const char *const creation_mode_verb_table
[_CREATION_MODE_MAX
] = {
1525 [CREATION_NORMAL
] = "Created",
1526 [CREATION_EXISTING
] = "Found existing",
1527 [CREATION_FORCE
] = "Created replacement",
1530 DEFINE_PRIVATE_STRING_TABLE_LOOKUP_TO_STRING(creation_mode_verb
, CreationMode
);
1532 static int create_directory_or_subvolume(const char *path
, mode_t mode
, bool subvol
, CreationMode
*creation
) {
1533 _cleanup_close_
int pfd
= -1;
1542 pfd
= path_open_parent_safe(path
);
1547 if (btrfs_is_subvol(empty_to_root(arg_root
)) <= 0)
1549 /* Don't create a subvolume unless the root directory is
1550 * one, too. We do this under the assumption that if the
1551 * root directory is just a plain directory (i.e. very
1552 * light-weight), we shouldn't try to split it up into
1553 * subvolumes (i.e. more heavy-weight). Thus, chroot()
1554 * environments and suchlike will get a full brtfs
1555 * subvolume set up below their tree only if they
1556 * specifically set up a btrfs subvolume for the root
1561 RUN_WITH_UMASK((~mode
) & 0777)
1562 r
= btrfs_subvol_make_fd(pfd
, basename(path
));
1567 if (!subvol
|| r
== -ENOTTY
)
1568 RUN_WITH_UMASK(0000)
1569 r
= mkdirat_label(pfd
, basename(path
), mode
);
1574 if (!IN_SET(r
, -EEXIST
, -EROFS
))
1575 return log_error_errno(r
, "Failed to create directory or subvolume \"%s\": %m", path
);
1578 if (k
== -ENOENT
&& r
== -EROFS
)
1579 return log_error_errno(r
, "%s does not exist and cannot be created as the file system is read-only.", path
);
1581 return log_error_errno(k
, "Failed to check if %s exists: %m", path
);
1583 log_warning("\"%s\" already exists and is not a directory.", path
);
1587 *creation
= CREATION_EXISTING
;
1589 *creation
= CREATION_NORMAL
;
1591 log_debug("%s directory \"%s\".", creation_mode_verb_to_string(*creation
), path
);
1593 r
= openat(pfd
, basename(path
), O_NOCTTY
|O_CLOEXEC
|O_DIRECTORY
);
1595 return log_error_errno(errno
, "Failed to open directory '%s': %m", basename(path
));
1600 static int create_directory(Item
*i
, const char *path
) {
1601 _cleanup_close_
int fd
= -1;
1604 assert(IN_SET(i
->type
, CREATE_DIRECTORY
, TRUNCATE_DIRECTORY
));
1606 fd
= create_directory_or_subvolume(path
, i
->mode
, false, NULL
);
1612 return fd_set_perms(i
, fd
, path
, NULL
);
1615 static int create_subvolume(Item
*i
, const char *path
) {
1616 _cleanup_close_
int fd
= -1;
1617 CreationMode creation
;
1621 assert(IN_SET(i
->type
, CREATE_SUBVOLUME
, CREATE_SUBVOLUME_NEW_QUOTA
, CREATE_SUBVOLUME_INHERIT_QUOTA
));
1623 fd
= create_directory_or_subvolume(path
, i
->mode
, true, &creation
);
1629 if (creation
== CREATION_NORMAL
&&
1630 IN_SET(i
->type
, CREATE_SUBVOLUME_NEW_QUOTA
, CREATE_SUBVOLUME_INHERIT_QUOTA
)) {
1631 r
= btrfs_subvol_auto_qgroup_fd(fd
, 0, i
->type
== CREATE_SUBVOLUME_NEW_QUOTA
);
1633 log_debug_errno(r
, "Couldn't adjust quota for subvolume \"%s\" (unsupported fs or dir not a subvolume): %m", i
->path
);
1634 else if (r
== -EROFS
)
1635 log_debug_errno(r
, "Couldn't adjust quota for subvolume \"%s\" (fs is read-only).", i
->path
);
1636 else if (r
== -ENOTCONN
)
1637 log_debug_errno(r
, "Couldn't adjust quota for subvolume \"%s\" (quota support is disabled).", i
->path
);
1639 q
= log_error_errno(r
, "Failed to adjust quota for subvolume \"%s\": %m", i
->path
);
1641 log_debug("Adjusted quota for subvolume \"%s\".", i
->path
);
1643 log_debug("Quota for subvolume \"%s\" already in place, no change made.", i
->path
);
1646 r
= fd_set_perms(i
, fd
, path
, NULL
);
1647 if (q
< 0) /* prefer the quota change error from above */
1653 static int empty_directory(Item
*i
, const char *path
) {
1657 assert(i
->type
== EMPTY_DIRECTORY
);
1659 r
= is_dir(path
, false);
1661 /* Option "e" operates only on existing objects. Do not
1662 * print errors about non-existent files or directories */
1663 log_debug("Skipping missing directory: %s", path
);
1667 return log_error_errno(r
, "is_dir() failed on path %s: %m", path
);
1669 return log_error_errno(SYNTHETIC_ERRNO(EEXIST
),
1670 "'%s' already exists and is not a directory.",
1673 return path_set_perms(i
, path
);
1676 static int create_device(Item
*i
, mode_t file_type
) {
1677 _cleanup_close_
int dfd
= -1, fd
= -1;
1678 CreationMode creation
;
1683 assert(IN_SET(file_type
, S_IFBLK
, S_IFCHR
));
1685 bn
= basename(i
->path
);
1687 /* Validate the path and use the returned directory fd for copying the
1688 * target so we're sure that the path can't be changed behind our
1690 dfd
= path_open_parent_safe(i
->path
);
1694 RUN_WITH_UMASK(0000) {
1695 mac_selinux_create_file_prepare(i
->path
, file_type
);
1696 r
= mknodat(dfd
, bn
, i
->mode
| file_type
, i
->major_minor
);
1697 mac_selinux_create_file_clear();
1703 if (errno
== EPERM
) {
1704 log_debug("We lack permissions, possibly because of cgroup configuration; "
1705 "skipping creation of device node %s.", i
->path
);
1709 if (errno
!= EEXIST
)
1710 return log_error_errno(errno
, "Failed to create device node %s: %m", i
->path
);
1712 if (fstatat(dfd
, bn
, &st
, 0) < 0)
1713 return log_error_errno(errno
, "stat(%s) failed: %m", i
->path
);
1715 if ((st
.st_mode
& S_IFMT
) != file_type
) {
1717 if (i
->append_or_force
) {
1719 RUN_WITH_UMASK(0000) {
1720 mac_selinux_create_file_prepare(i
->path
, file_type
);
1721 /* FIXME: need to introduce mknodat_atomic() */
1722 r
= mknod_atomic(i
->path
, i
->mode
| file_type
, i
->major_minor
);
1723 mac_selinux_create_file_clear();
1727 return log_error_errno(r
, "Failed to create device node \"%s\": %m", i
->path
);
1728 creation
= CREATION_FORCE
;
1730 log_debug("%s is not a device node.", i
->path
);
1734 creation
= CREATION_EXISTING
;
1736 creation
= CREATION_NORMAL
;
1738 log_debug("%s %s device node \"%s\" %u:%u.",
1739 creation_mode_verb_to_string(creation
),
1740 i
->type
== CREATE_BLOCK_DEVICE
? "block" : "char",
1741 i
->path
, major(i
->mode
), minor(i
->mode
));
1743 fd
= openat(dfd
, bn
, O_NOFOLLOW
|O_CLOEXEC
|O_PATH
);
1745 return log_error_errno(errno
, "Failed to openat(%s): %m", i
->path
);
1747 return fd_set_perms(i
, fd
, i
->path
, NULL
);
1750 static int create_fifo(Item
*i
, const char *path
) {
1751 _cleanup_close_
int pfd
= -1, fd
= -1;
1752 CreationMode creation
;
1757 pfd
= path_open_parent_safe(path
);
1761 bn
= basename(path
);
1763 RUN_WITH_UMASK(0000) {
1764 mac_selinux_create_file_prepare(path
, S_IFIFO
);
1765 r
= mkfifoat(pfd
, bn
, i
->mode
);
1766 mac_selinux_create_file_clear();
1770 if (errno
!= EEXIST
)
1771 return log_error_errno(errno
, "Failed to create fifo %s: %m", path
);
1773 if (fstatat(pfd
, bn
, &st
, AT_SYMLINK_NOFOLLOW
) < 0)
1774 return log_error_errno(errno
, "stat(%s) failed: %m", path
);
1776 if (!S_ISFIFO(st
.st_mode
)) {
1778 if (i
->append_or_force
) {
1779 RUN_WITH_UMASK(0000) {
1780 mac_selinux_create_file_prepare(path
, S_IFIFO
);
1781 r
= mkfifoat_atomic(pfd
, bn
, i
->mode
);
1782 mac_selinux_create_file_clear();
1786 return log_error_errno(r
, "Failed to create fifo %s: %m", path
);
1787 creation
= CREATION_FORCE
;
1789 log_warning("\"%s\" already exists and is not a fifo.", path
);
1793 creation
= CREATION_EXISTING
;
1795 creation
= CREATION_NORMAL
;
1797 log_debug("%s fifo \"%s\".", creation_mode_verb_to_string(creation
), path
);
1799 fd
= openat(pfd
, bn
, O_NOFOLLOW
|O_CLOEXEC
|O_PATH
);
1801 return log_error_errno(errno
, "Failed to openat(%s): %m", path
);
1803 return fd_set_perms(i
, fd
, i
->path
, NULL
);
1806 typedef int (*action_t
)(Item
*i
, const char *path
);
1807 typedef int (*fdaction_t
)(Item
*i
, int fd
, const char *path
, const struct stat
*st
);
1809 static int item_do(Item
*i
, int fd
, const char *path
, fdaction_t action
) {
1817 if (fstat(fd
, &st
) < 0) {
1818 r
= log_error_errno(errno
, "fstat() on file failed: %m");
1822 /* This returns the first error we run into, but nevertheless
1824 r
= action(i
, fd
, path
, &st
);
1826 if (S_ISDIR(st
.st_mode
)) {
1827 char procfs_path
[STRLEN("/proc/self/fd/") + DECIMAL_STR_MAX(int)];
1828 _cleanup_closedir_
DIR *d
= NULL
;
1831 /* The passed 'fd' was opened with O_PATH. We need to convert
1832 * it into a 'regular' fd before reading the directory content. */
1833 xsprintf(procfs_path
, "/proc/self/fd/%i", fd
);
1835 d
= opendir(procfs_path
);
1837 log_error_errno(errno
, "Failed to opendir() '%s': %m", procfs_path
);
1843 FOREACH_DIRENT_ALL(de
, d
, q
= -errno
; goto finish
) {
1846 if (dot_or_dot_dot(de
->d_name
))
1849 de_fd
= openat(fd
, de
->d_name
, O_NOFOLLOW
|O_CLOEXEC
|O_PATH
);
1851 q
= log_error_errno(errno
, "Failed to open() file '%s': %m", de
->d_name
);
1853 _cleanup_free_
char *de_path
= NULL
;
1855 de_path
= path_join(path
, de
->d_name
);
1859 /* Pass ownership of dirent fd over */
1860 q
= item_do(i
, de_fd
, de_path
, action
);
1863 if (q
< 0 && r
== 0)
1872 static int glob_item(Item
*i
, action_t action
) {
1873 _cleanup_globfree_ glob_t g
= {
1874 .gl_opendir
= (void *(*)(const char *)) opendir_nomod
,
1879 k
= safe_glob(i
->path
, GLOB_NOSORT
|GLOB_BRACE
, &g
);
1880 if (k
< 0 && k
!= -ENOENT
)
1881 return log_error_errno(k
, "glob(%s) failed: %m", i
->path
);
1883 STRV_FOREACH(fn
, g
.gl_pathv
) {
1885 if (k
< 0 && r
== 0)
1892 static int glob_item_recursively(Item
*i
, fdaction_t action
) {
1893 _cleanup_globfree_ glob_t g
= {
1894 .gl_opendir
= (void *(*)(const char *)) opendir_nomod
,
1899 k
= safe_glob(i
->path
, GLOB_NOSORT
|GLOB_BRACE
, &g
);
1900 if (k
< 0 && k
!= -ENOENT
)
1901 return log_error_errno(k
, "glob(%s) failed: %m", i
->path
);
1903 STRV_FOREACH(fn
, g
.gl_pathv
) {
1904 _cleanup_close_
int fd
= -1;
1906 /* Make sure we won't trigger/follow file object (such as
1907 * device nodes, automounts, ...) pointed out by 'fn' with
1908 * O_PATH. Note, when O_PATH is used, flags other than
1909 * O_CLOEXEC, O_DIRECTORY, and O_NOFOLLOW are ignored. */
1911 fd
= open(*fn
, O_CLOEXEC
|O_NOFOLLOW
|O_PATH
);
1913 log_error_errno(errno
, "Opening '%s' failed: %m", *fn
);
1919 k
= item_do(i
, fd
, *fn
, action
);
1920 if (k
< 0 && r
== 0)
1923 /* we passed fd ownership to the previous call */
1930 static int create_item(Item
*i
) {
1931 CreationMode creation
;
1936 log_debug("Running create action for entry %c %s", (char) i
->type
, i
->path
);
1941 case IGNORE_DIRECTORY_PATH
:
1943 case RECURSIVE_REMOVE_PATH
:
1948 RUN_WITH_UMASK(0000)
1949 (void) mkdir_parents_label(i
->path
, 0755);
1951 if ((i
->type
== CREATE_FILE
&& i
->append_or_force
) || i
->type
== TRUNCATE_FILE
)
1952 r
= truncate_file(i
, i
->path
);
1954 r
= create_file(i
, i
->path
);
1961 RUN_WITH_UMASK(0000)
1962 (void) mkdir_parents_label(i
->path
, 0755);
1970 r
= glob_item(i
, write_one_file
);
1976 case CREATE_DIRECTORY
:
1977 case TRUNCATE_DIRECTORY
:
1978 RUN_WITH_UMASK(0000)
1979 (void) mkdir_parents_label(i
->path
, 0755);
1981 r
= create_directory(i
, i
->path
);
1986 case CREATE_SUBVOLUME
:
1987 case CREATE_SUBVOLUME_INHERIT_QUOTA
:
1988 case CREATE_SUBVOLUME_NEW_QUOTA
:
1989 RUN_WITH_UMASK(0000)
1990 (void) mkdir_parents_label(i
->path
, 0755);
1992 r
= create_subvolume(i
, i
->path
);
1997 case EMPTY_DIRECTORY
:
1998 r
= glob_item(i
, empty_directory
);
2004 RUN_WITH_UMASK(0000)
2005 (void) mkdir_parents_label(i
->path
, 0755);
2007 r
= create_fifo(i
, i
->path
);
2012 case CREATE_SYMLINK
: {
2013 RUN_WITH_UMASK(0000)
2014 (void) mkdir_parents_label(i
->path
, 0755);
2016 mac_selinux_create_file_prepare(i
->path
, S_IFLNK
);
2017 r
= symlink(i
->argument
, i
->path
);
2018 mac_selinux_create_file_clear();
2021 _cleanup_free_
char *x
= NULL
;
2023 if (errno
!= EEXIST
)
2024 return log_error_errno(errno
, "symlink(%s, %s) failed: %m", i
->argument
, i
->path
);
2026 r
= readlink_malloc(i
->path
, &x
);
2027 if (r
< 0 || !streq(i
->argument
, x
)) {
2029 if (i
->append_or_force
) {
2030 mac_selinux_create_file_prepare(i
->path
, S_IFLNK
);
2031 r
= symlink_atomic(i
->argument
, i
->path
);
2032 mac_selinux_create_file_clear();
2034 if (IN_SET(r
, -EISDIR
, -EEXIST
, -ENOTEMPTY
)) {
2035 r
= rm_rf(i
->path
, REMOVE_ROOT
|REMOVE_PHYSICAL
);
2037 return log_error_errno(r
, "rm -fr %s failed: %m", i
->path
);
2039 mac_selinux_create_file_prepare(i
->path
, S_IFLNK
);
2040 r
= symlink(i
->argument
, i
->path
) < 0 ? -errno
: 0;
2041 mac_selinux_create_file_clear();
2044 return log_error_errno(r
, "symlink(%s, %s) failed: %m", i
->argument
, i
->path
);
2046 creation
= CREATION_FORCE
;
2048 log_debug("\"%s\" is not a symlink or does not point to the correct path.", i
->path
);
2052 creation
= CREATION_EXISTING
;
2055 creation
= CREATION_NORMAL
;
2056 log_debug("%s symlink \"%s\".", creation_mode_verb_to_string(creation
), i
->path
);
2060 case CREATE_BLOCK_DEVICE
:
2061 case CREATE_CHAR_DEVICE
:
2062 if (have_effective_cap(CAP_MKNOD
) == 0) {
2063 /* In a container we lack CAP_MKNOD. We shouldn't attempt to create the device node in that
2064 * case to avoid noise, and we don't support virtualized devices in containers anyway. */
2066 log_debug("We lack CAP_MKNOD, skipping creation of device node %s.", i
->path
);
2070 RUN_WITH_UMASK(0000)
2071 (void) mkdir_parents_label(i
->path
, 0755);
2073 r
= create_device(i
, i
->type
== CREATE_BLOCK_DEVICE
? S_IFBLK
: S_IFCHR
);
2081 r
= glob_item(i
, path_set_perms
);
2086 case RECURSIVE_RELABEL_PATH
:
2087 r
= glob_item_recursively(i
, fd_set_perms
);
2093 r
= glob_item(i
, path_set_xattrs
);
2098 case RECURSIVE_SET_XATTR
:
2099 r
= glob_item_recursively(i
, fd_set_xattrs
);
2105 r
= glob_item(i
, path_set_acls
);
2110 case RECURSIVE_SET_ACL
:
2111 r
= glob_item_recursively(i
, fd_set_acls
);
2117 r
= glob_item(i
, path_set_attribute
);
2122 case RECURSIVE_SET_ATTRIBUTE
:
2123 r
= glob_item_recursively(i
, fd_set_attribute
);
2132 static int remove_item_instance(Item
*i
, const char *instance
) {
2140 if (remove(instance
) < 0 && errno
!= ENOENT
)
2141 return log_error_errno(errno
, "rm(%s): %m", instance
);
2145 case RECURSIVE_REMOVE_PATH
:
2146 /* FIXME: we probably should use dir_cleanup() here instead of rm_rf() so that 'x' is honoured. */
2147 log_debug("rm -rf \"%s\"", instance
);
2148 r
= rm_rf(instance
, REMOVE_ROOT
|REMOVE_SUBVOLUME
|REMOVE_PHYSICAL
);
2149 if (r
< 0 && r
!= -ENOENT
)
2150 return log_error_errno(r
, "rm_rf(%s): %m", instance
);
2155 assert_not_reached("wut?");
2161 static int remove_item(Item
*i
) {
2166 log_debug("Running remove action for entry %c %s", (char) i
->type
, i
->path
);
2170 case TRUNCATE_DIRECTORY
:
2171 /* FIXME: we probably should use dir_cleanup() here instead of rm_rf() so that 'x' is honoured. */
2172 log_debug("rm -rf \"%s\"", i
->path
);
2173 r
= rm_rf(i
->path
, REMOVE_PHYSICAL
);
2174 if (r
< 0 && r
!= -ENOENT
)
2175 return log_error_errno(r
, "rm_rf(%s): %m", i
->path
);
2180 case RECURSIVE_REMOVE_PATH
:
2181 return glob_item(i
, remove_item_instance
);
2188 static int clean_item_instance(Item
*i
, const char* instance
) {
2189 _cleanup_closedir_
DIR *d
= NULL
;
2193 char timestamp
[FORMAT_TIMESTAMP_MAX
];
2200 n
= now(CLOCK_REALTIME
);
2204 cutoff
= n
- i
->age
;
2206 d
= opendir_nomod(instance
);
2208 if (IN_SET(errno
, ENOENT
, ENOTDIR
)) {
2209 log_debug_errno(errno
, "Directory \"%s\": %m", instance
);
2213 return log_error_errno(errno
, "Failed to open directory %s: %m", instance
);
2216 if (fstat(dirfd(d
), &s
) < 0)
2217 return log_error_errno(errno
, "stat(%s) failed: %m", i
->path
);
2219 if (!S_ISDIR(s
.st_mode
))
2220 return log_error_errno(SYNTHETIC_ERRNO(ENOTDIR
),
2221 "%s is not a directory.", i
->path
);
2223 if (fstatat(dirfd(d
), "..", &ps
, AT_SYMLINK_NOFOLLOW
) != 0)
2224 return log_error_errno(errno
, "stat(%s/..) failed: %m", i
->path
);
2226 mountpoint
= s
.st_dev
!= ps
.st_dev
|| s
.st_ino
== ps
.st_ino
;
2228 log_debug("Cleanup threshold for %s \"%s\" is %s",
2229 mountpoint
? "mount point" : "directory",
2231 format_timestamp_us(timestamp
, sizeof(timestamp
), cutoff
));
2233 return dir_cleanup(i
, instance
, d
, &s
, cutoff
, s
.st_dev
, mountpoint
,
2234 MAX_DEPTH
, i
->keep_first_level
);
2237 static int clean_item(Item
*i
) {
2240 log_debug("Running clean action for entry %c %s", (char) i
->type
, i
->path
);
2243 case CREATE_DIRECTORY
:
2244 case CREATE_SUBVOLUME
:
2245 case CREATE_SUBVOLUME_INHERIT_QUOTA
:
2246 case CREATE_SUBVOLUME_NEW_QUOTA
:
2247 case TRUNCATE_DIRECTORY
:
2250 clean_item_instance(i
, i
->path
);
2252 case EMPTY_DIRECTORY
:
2253 case IGNORE_DIRECTORY_PATH
:
2254 return glob_item(i
, clean_item_instance
);
2260 static int process_item(Item
*i
, OperationMask operation
) {
2266 todo
= operation
& ~i
->done
;
2267 if (todo
== 0) /* Everything already done? */
2270 i
->done
|= operation
;
2272 r
= chase_symlinks(i
->path
, arg_root
, CHASE_NO_AUTOFS
|CHASE_WARN
, NULL
, NULL
);
2273 if (r
== -EREMOTE
) {
2274 log_notice_errno(r
, "Skipping %s", i
->path
);
2278 log_debug_errno(r
, "Failed to determine whether '%s' is below autofs, ignoring: %m", i
->path
);
2280 r
= FLAGS_SET(operation
, OPERATION_CREATE
) ? create_item(i
) : 0;
2281 /* Failure can only be tolerated for create */
2282 if (i
->allow_failure
)
2285 q
= FLAGS_SET(operation
, OPERATION_REMOVE
) ? remove_item(i
) : 0;
2286 p
= FLAGS_SET(operation
, OPERATION_CLEAN
) ? clean_item(i
) : 0;
2293 static int process_item_array(ItemArray
*array
, OperationMask operation
) {
2299 /* Create any parent first. */
2300 if (FLAGS_SET(operation
, OPERATION_CREATE
) && array
->parent
)
2301 r
= process_item_array(array
->parent
, operation
& OPERATION_CREATE
);
2303 /* Clean up all children first */
2304 if ((operation
& (OPERATION_REMOVE
|OPERATION_CLEAN
)) && !set_isempty(array
->children
)) {
2308 SET_FOREACH(c
, array
->children
, i
) {
2311 k
= process_item_array(c
, operation
& (OPERATION_REMOVE
|OPERATION_CLEAN
));
2312 if (k
< 0 && r
== 0)
2317 for (n
= 0; n
< array
->n_items
; n
++) {
2320 k
= process_item(array
->items
+ n
, operation
);
2321 if (k
< 0 && r
== 0)
2328 static void item_free_contents(Item
*i
) {
2332 strv_free(i
->xattrs
);
2335 acl_free(i
->acl_access
);
2336 acl_free(i
->acl_default
);
2340 static ItemArray
* item_array_free(ItemArray
*a
) {
2346 for (n
= 0; n
< a
->n_items
; n
++)
2347 item_free_contents(a
->items
+ n
);
2349 set_free(a
->children
);
2354 static int item_compare(const Item
*a
, const Item
*b
) {
2355 /* Make sure that the ownership taking item is put first, so
2356 * that we first create the node, and then can adjust it */
2358 if (takes_ownership(a
->type
) && !takes_ownership(b
->type
))
2360 if (!takes_ownership(a
->type
) && takes_ownership(b
->type
))
2363 return CMP(a
->type
, b
->type
);
2366 static bool item_compatible(Item
*a
, Item
*b
) {
2369 assert(streq(a
->path
, b
->path
));
2371 if (takes_ownership(a
->type
) && takes_ownership(b
->type
))
2372 /* check if the items are the same */
2373 return streq_ptr(a
->argument
, b
->argument
) &&
2375 a
->uid_set
== b
->uid_set
&&
2378 a
->gid_set
== b
->gid_set
&&
2381 a
->mode_set
== b
->mode_set
&&
2382 a
->mode
== b
->mode
&&
2384 a
->age_set
== b
->age_set
&&
2387 a
->mask_perms
== b
->mask_perms
&&
2389 a
->keep_first_level
== b
->keep_first_level
&&
2391 a
->major_minor
== b
->major_minor
;
2396 static bool should_include_path(const char *path
) {
2399 STRV_FOREACH(prefix
, arg_exclude_prefixes
)
2400 if (path_startswith(path
, *prefix
)) {
2401 log_debug("Entry \"%s\" matches exclude prefix \"%s\", skipping.",
2406 STRV_FOREACH(prefix
, arg_include_prefixes
)
2407 if (path_startswith(path
, *prefix
)) {
2408 log_debug("Entry \"%s\" matches include prefix \"%s\".", path
, *prefix
);
2412 /* no matches, so we should include this path only if we have no allow list at all */
2413 if (strv_isempty(arg_include_prefixes
))
2416 log_debug("Entry \"%s\" does not match any include prefix, skipping.", path
);
2420 static int specifier_expansion_from_arg(Item
*i
) {
2421 _cleanup_free_
char *unescaped
= NULL
, *resolved
= NULL
;
2432 case CREATE_SYMLINK
:
2436 r
= cunescape(i
->argument
, 0, &unescaped
);
2438 return log_error_errno(r
, "Failed to unescape parameter to write: %s", i
->argument
);
2440 r
= specifier_printf(unescaped
, specifier_table
, NULL
, &resolved
);
2444 free_and_replace(i
->argument
, resolved
);
2448 case RECURSIVE_SET_XATTR
:
2449 STRV_FOREACH(xattr
, i
->xattrs
) {
2450 r
= specifier_printf(*xattr
, specifier_table
, NULL
, &resolved
);
2454 free_and_replace(*xattr
, resolved
);
2464 static int patch_var_run(const char *fname
, unsigned line
, char **path
) {
2471 /* Optionally rewrites lines referencing /var/run/, to use /run/ instead. Why bother? tmpfiles merges lines in
2472 * some cases and detects conflicts in others. If files/directories are specified through two equivalent lines
2473 * this is problematic as neither case will be detected. Ideally we'd detect these cases by resolving symlinks
2474 * early, but that's precisely not what we can do here as this code very likely is running very early on, at a
2475 * time where the paths in question are not available yet, or even more importantly, our own tmpfiles rules
2476 * might create the paths that are intermediary to the listed paths. We can't really cover the generic case,
2477 * but the least we can do is cover the specific case of /var/run vs. /run, as /var/run is a legacy name for
2478 * /run only, and we explicitly document that and require that on systemd systems the former is a symlink to
2479 * the latter. Moreover files below this path are by far the primary usecase for tmpfiles.d/. */
2481 k
= path_startswith(*path
, "/var/run/");
2482 if (isempty(k
)) /* Don't complain about other paths than /var/run, and not about /var/run itself either. */
2485 n
= path_join("/run", k
);
2489 /* Also log about this briefly. We do so at LOG_NOTICE level, as we fixed up the situation automatically, hence
2490 * there's no immediate need for action by the user. However, in the interest of making things less confusing
2491 * to the user, let's still inform the user that these snippets should really be updated. */
2492 log_syntax(NULL
, LOG_NOTICE
, fname
, line
, 0, "Line references path below legacy directory /var/run/, updating %s → %s; please update the tmpfiles.d/ drop-in file accordingly.", *path
, n
);
2494 free_and_replace(*path
, n
);
2499 static int find_uid(const char *user
, uid_t
*ret_uid
, Hashmap
**cache
) {
2505 /* First: parse as numeric UID string */
2506 r
= parse_uid(user
, ret_uid
);
2510 /* Second: pass to NSS if we are running "online" */
2512 return get_user_creds(&user
, ret_uid
, NULL
, NULL
, NULL
, 0);
2514 /* Third, synthesize "root" unconditionally */
2515 if (streq(user
, "root")) {
2520 /* Fourth: use fgetpwent() to read /etc/passwd directly, if we are "offline" */
2521 return name_to_uid_offline(arg_root
, user
, ret_uid
, cache
);
2524 static int find_gid(const char *group
, gid_t
*ret_gid
, Hashmap
**cache
) {
2530 /* First: parse as numeric GID string */
2531 r
= parse_gid(group
, ret_gid
);
2535 /* Second: pass to NSS if we are running "online" */
2537 return get_group_creds(&group
, ret_gid
, 0);
2539 /* Third, synthesize "root" unconditionally */
2540 if (streq(group
, "root")) {
2545 /* Fourth: use fgetgrent() to read /etc/group directly, if we are "offline" */
2546 return name_to_gid_offline(arg_root
, group
, ret_gid
, cache
);
2549 static int parse_line(
2553 bool *invalid_config
,
2554 Hashmap
**uid_cache
,
2555 Hashmap
**gid_cache
) {
2557 _cleanup_free_
char *action
= NULL
, *mode
= NULL
, *user
= NULL
, *group
= NULL
, *age
= NULL
, *path
= NULL
;
2558 _cleanup_(item_free_contents
) Item i
= {};
2559 ItemArray
*existing
;
2562 bool append_or_force
= false, boot
= false, allow_failure
= false;
2568 r
= extract_many_words(
2580 if (IN_SET(r
, -EINVAL
, -EBADSLT
))
2581 /* invalid quoting and such or an unknown specifier */
2582 *invalid_config
= true;
2583 return log_syntax(NULL
, LOG_ERR
, fname
, line
, r
, "Failed to parse line: %m");
2585 *invalid_config
= true;
2586 return log_syntax(NULL
, LOG_ERR
, fname
, line
, SYNTHETIC_ERRNO(EBADMSG
), "Syntax error.");
2589 if (!empty_or_dash(buffer
)) {
2590 i
.argument
= strdup(buffer
);
2595 if (isempty(action
)) {
2596 *invalid_config
= true;
2597 return log_syntax(NULL
, LOG_ERR
, fname
, line
, SYNTHETIC_ERRNO(EBADMSG
), "Command too short '%s'.", action
);
2600 for (pos
= 1; action
[pos
]; pos
++) {
2601 if (action
[pos
] == '!' && !boot
)
2603 else if (action
[pos
] == '+' && !append_or_force
)
2604 append_or_force
= true;
2605 else if (action
[pos
] == '-' && !allow_failure
)
2606 allow_failure
= true;
2608 *invalid_config
= true;
2609 return log_syntax(NULL
, LOG_ERR
, fname
, line
, SYNTHETIC_ERRNO(EBADMSG
), "Unknown modifiers in command '%s'", action
);
2613 if (boot
&& !arg_boot
) {
2614 log_syntax(NULL
, LOG_DEBUG
, fname
, line
, 0, "Ignoring entry %s \"%s\" because --boot is not specified.", action
, path
);
2619 i
.append_or_force
= append_or_force
;
2620 i
.allow_failure
= allow_failure
;
2622 r
= specifier_printf(path
, specifier_table
, NULL
, &i
.path
);
2624 return log_unresolvable_specifier(fname
, line
);
2626 if (IN_SET(r
, -EINVAL
, -EBADSLT
))
2627 *invalid_config
= true;
2628 return log_syntax(NULL
, LOG_ERR
, fname
, line
, r
, "Failed to replace specifiers in '%s': %m", path
);
2631 r
= patch_var_run(fname
, line
, &i
.path
);
2637 case CREATE_DIRECTORY
:
2638 case CREATE_SUBVOLUME
:
2639 case CREATE_SUBVOLUME_INHERIT_QUOTA
:
2640 case CREATE_SUBVOLUME_NEW_QUOTA
:
2641 case EMPTY_DIRECTORY
:
2642 case TRUNCATE_DIRECTORY
:
2645 case IGNORE_DIRECTORY_PATH
:
2647 case RECURSIVE_REMOVE_PATH
:
2650 case RECURSIVE_RELABEL_PATH
:
2652 log_syntax(NULL
, LOG_WARNING
, fname
, line
, 0, "%c lines don't take argument fields, ignoring.", i
.type
);
2660 case CREATE_SYMLINK
:
2662 i
.argument
= path_join("/usr/share/factory", i
.path
);
2670 *invalid_config
= true;
2671 return log_syntax(NULL
, LOG_ERR
, fname
, line
, SYNTHETIC_ERRNO(EBADMSG
), "Write file requires argument.");
2677 i
.argument
= path_join("/usr/share/factory", i
.path
);
2681 } else if (!path_is_absolute(i
.argument
)) {
2682 *invalid_config
= true;
2683 return log_syntax(NULL
, LOG_ERR
, fname
, line
, SYNTHETIC_ERRNO(EBADMSG
), "Source path '%s' is not absolute.", i
.argument
);
2687 if (!empty_or_root(arg_root
)) {
2690 p
= path_join(arg_root
, i
.argument
);
2693 free_and_replace(i
.argument
, p
);
2696 path_simplify(i
.argument
, false);
2699 case CREATE_CHAR_DEVICE
:
2700 case CREATE_BLOCK_DEVICE
:
2702 *invalid_config
= true;
2703 return log_syntax(NULL
, LOG_ERR
, fname
, line
, SYNTHETIC_ERRNO(EBADMSG
), "Device file requires argument.");
2706 r
= parse_dev(i
.argument
, &i
.major_minor
);
2708 *invalid_config
= true;
2709 return log_syntax(NULL
, LOG_ERR
, fname
, line
, r
, "Can't parse device file major/minor '%s'.", i
.argument
);
2715 case RECURSIVE_SET_XATTR
:
2717 *invalid_config
= true;
2718 return log_syntax(NULL
, LOG_ERR
, fname
, line
, SYNTHETIC_ERRNO(EBADMSG
),
2719 "Set extended attribute requires argument.");
2721 r
= parse_xattrs_from_arg(&i
);
2727 case RECURSIVE_SET_ACL
:
2729 *invalid_config
= true;
2730 return log_syntax(NULL
, LOG_ERR
, fname
, line
, SYNTHETIC_ERRNO(EBADMSG
),
2731 "Set ACLs requires argument.");
2733 r
= parse_acls_from_arg(&i
);
2739 case RECURSIVE_SET_ATTRIBUTE
:
2741 *invalid_config
= true;
2742 return log_syntax(NULL
, LOG_ERR
, fname
, line
, SYNTHETIC_ERRNO(EBADMSG
),
2743 "Set file attribute requires argument.");
2745 r
= parse_attribute_from_arg(&i
);
2746 if (IN_SET(r
, -EINVAL
, -EBADSLT
))
2747 *invalid_config
= true;
2753 *invalid_config
= true;
2754 return log_syntax(NULL
, LOG_ERR
, fname
, line
, SYNTHETIC_ERRNO(EBADMSG
),
2755 "Unknown command type '%c'.", (char) i
.type
);
2758 if (!path_is_absolute(i
.path
)) {
2759 *invalid_config
= true;
2760 return log_syntax(NULL
, LOG_ERR
, fname
, line
, SYNTHETIC_ERRNO(EBADMSG
),
2761 "Path '%s' not absolute.", i
.path
);
2764 path_simplify(i
.path
, false);
2766 if (!should_include_path(i
.path
))
2769 r
= specifier_expansion_from_arg(&i
);
2771 return log_unresolvable_specifier(fname
, line
);
2773 if (IN_SET(r
, -EINVAL
, -EBADSLT
))
2774 *invalid_config
= true;
2775 return log_syntax(NULL
, LOG_ERR
, fname
, line
, r
, "Failed to substitute specifiers in argument: %m");
2778 if (!empty_or_root(arg_root
)) {
2781 p
= path_join(arg_root
, i
.path
);
2784 free_and_replace(i
.path
, p
);
2787 if (!empty_or_dash(user
)) {
2788 r
= find_uid(user
, &i
.uid
, uid_cache
);
2790 *invalid_config
= true;
2791 return log_syntax(NULL
, LOG_ERR
, fname
, line
, r
, "Failed to resolve user '%s': %m", user
);
2797 if (!empty_or_dash(group
)) {
2798 r
= find_gid(group
, &i
.gid
, gid_cache
);
2800 *invalid_config
= true;
2801 return log_syntax(NULL
, LOG_ERR
, fname
, line
, r
, "Failed to resolve group '%s'.", group
);
2807 if (!empty_or_dash(mode
)) {
2808 const char *mm
= mode
;
2812 i
.mask_perms
= true;
2816 r
= parse_mode(mm
, &m
);
2818 *invalid_config
= true;
2819 return log_syntax(NULL
, LOG_ERR
, fname
, line
, r
, "Invalid mode '%s'.", mode
);
2825 i
.mode
= IN_SET(i
.type
, CREATE_DIRECTORY
, TRUNCATE_DIRECTORY
, CREATE_SUBVOLUME
, CREATE_SUBVOLUME_INHERIT_QUOTA
, CREATE_SUBVOLUME_NEW_QUOTA
) ? 0755 : 0644;
2827 if (!empty_or_dash(age
)) {
2828 const char *a
= age
;
2831 i
.keep_first_level
= true;
2835 r
= parse_sec(a
, &i
.age
);
2837 *invalid_config
= true;
2838 return log_syntax(NULL
, LOG_ERR
, fname
, line
, r
, "Invalid age '%s'.", age
);
2844 h
= needs_glob(i
.type
) ? globs
: items
;
2846 existing
= ordered_hashmap_get(h
, i
.path
);
2850 for (n
= 0; n
< existing
->n_items
; n
++) {
2851 if (!item_compatible(existing
->items
+ n
, &i
) && !i
.append_or_force
) {
2852 log_syntax(NULL
, LOG_NOTICE
, fname
, line
, 0, "Duplicate line for path \"%s\", ignoring.", i
.path
);
2857 existing
= new0(ItemArray
, 1);
2861 r
= ordered_hashmap_put(h
, i
.path
, existing
);
2868 if (!GREEDY_REALLOC(existing
->items
, existing
->allocated
, existing
->n_items
+ 1))
2871 existing
->items
[existing
->n_items
++] = i
;
2872 i
= (struct Item
) {};
2874 /* Sort item array, to enforce stable ordering of application */
2875 typesafe_qsort(existing
->items
, existing
->n_items
, item_compare
);
2880 static int cat_config(char **config_dirs
, char **args
) {
2881 _cleanup_strv_free_
char **files
= NULL
;
2884 r
= conf_files_list_with_replacement(arg_root
, config_dirs
, arg_replace
, &files
, NULL
);
2888 return cat_files(NULL
, files
, 0);
2891 static int exclude_default_prefixes(void) {
2894 /* Provide an easy way to exclude virtual/memory file systems from what we do here. Useful in
2895 * combination with --root= where we probably don't want to apply stuff to these dirs as they are
2896 * likely over-mounted if the root directory is actually used, and it wouldbe less than ideal to have
2897 * all kinds of files created/adjusted underneath these mount points. */
2899 r
= strv_extend_strv(
2900 &arg_exclude_prefixes
,
2912 static int help(void) {
2913 _cleanup_free_
char *link
= NULL
;
2916 r
= terminal_urlify_man("systemd-tmpfiles", "8", &link
);
2920 printf("%s [OPTIONS...] [CONFIGURATION FILE...]\n\n"
2921 "Creates, deletes and cleans up volatile and temporary files and directories.\n\n"
2922 " -h --help Show this help\n"
2923 " --user Execute user configuration\n"
2924 " --version Show package version\n"
2925 " --cat-config Show configuration files\n"
2926 " --create Create marked files/directories\n"
2927 " --clean Clean up marked directories\n"
2928 " --remove Remove marked files/directories\n"
2929 " --boot Execute actions only safe at boot\n"
2930 " --prefix=PATH Only apply rules with the specified prefix\n"
2931 " --exclude-prefix=PATH Ignore rules with the specified prefix\n"
2932 " -E Ignore rules prefixed with /dev, /proc, /run, /sys\n"
2933 " --root=PATH Operate on an alternate filesystem root\n"
2934 " --image=PATH Operate on disk image as filesystem root\n"
2935 " --replace=PATH Treat arguments as replacement for PATH\n"
2936 " --no-pager Do not pipe output into a pager\n"
2937 "\nSee the %s for details.\n"
2938 , program_invocation_short_name
2945 static int parse_argv(int argc
, char *argv
[]) {
2948 ARG_VERSION
= 0x100,
2963 static const struct option options
[] = {
2964 { "help", no_argument
, NULL
, 'h' },
2965 { "user", no_argument
, NULL
, ARG_USER
},
2966 { "version", no_argument
, NULL
, ARG_VERSION
},
2967 { "cat-config", no_argument
, NULL
, ARG_CAT_CONFIG
},
2968 { "create", no_argument
, NULL
, ARG_CREATE
},
2969 { "clean", no_argument
, NULL
, ARG_CLEAN
},
2970 { "remove", no_argument
, NULL
, ARG_REMOVE
},
2971 { "boot", no_argument
, NULL
, ARG_BOOT
},
2972 { "prefix", required_argument
, NULL
, ARG_PREFIX
},
2973 { "exclude-prefix", required_argument
, NULL
, ARG_EXCLUDE_PREFIX
},
2974 { "root", required_argument
, NULL
, ARG_ROOT
},
2975 { "image", required_argument
, NULL
, ARG_IMAGE
},
2976 { "replace", required_argument
, NULL
, ARG_REPLACE
},
2977 { "no-pager", no_argument
, NULL
, ARG_NO_PAGER
},
2986 while ((c
= getopt_long(argc
, argv
, "hE", options
, NULL
)) >= 0)
2996 case ARG_CAT_CONFIG
:
2997 arg_cat_config
= true;
3005 arg_operation
|= OPERATION_CREATE
;
3009 arg_operation
|= OPERATION_CLEAN
;
3013 arg_operation
|= OPERATION_REMOVE
;
3021 if (strv_push(&arg_include_prefixes
, optarg
) < 0)
3025 case ARG_EXCLUDE_PREFIX
:
3026 if (strv_push(&arg_exclude_prefixes
, optarg
) < 0)
3031 r
= parse_path_argument_and_warn(optarg
, /* suppress_root= */ false, &arg_root
);
3037 r
= parse_path_argument_and_warn(optarg
, /* suppress_root= */ false, &arg_image
);
3041 /* Imply -E here since it makes little sense to create files persistently in the /run mointpoint of a disk image */
3045 r
= exclude_default_prefixes();
3052 if (!path_is_absolute(optarg
) ||
3053 !endswith(optarg
, ".conf"))
3054 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
3055 "The argument to --replace= must an absolute path to a config file");
3057 arg_replace
= optarg
;
3061 arg_pager_flags
|= PAGER_DISABLE
;
3068 assert_not_reached("Unhandled option");
3071 if (arg_operation
== 0 && !arg_cat_config
)
3072 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
3073 "You need to specify at least one of --clean, --create or --remove.");
3075 if (arg_replace
&& arg_cat_config
)
3076 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
3077 "Option --replace= is not supported with --cat-config");
3079 if (arg_replace
&& optind
>= argc
)
3080 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
3081 "When --replace= is given, some configuration items must be specified");
3083 if (arg_root
&& arg_user
)
3084 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
3085 "Combination of --user and --root= is not supported.");
3087 if (arg_image
&& arg_root
)
3088 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "Please specify either --root= or --image=, the combination of both is not supported.");
3093 static int read_config_file(char **config_dirs
, const char *fn
, bool ignore_enoent
, bool *invalid_config
) {
3094 _cleanup_(hashmap_freep
) Hashmap
*uid_cache
= NULL
, *gid_cache
= NULL
;
3095 _cleanup_fclose_
FILE *_f
= NULL
;
3104 if (streq(fn
, "-")) {
3105 log_debug("Reading config from stdin…");
3109 r
= search_and_fopen(fn
, "re", arg_root
, (const char**) config_dirs
, &_f
);
3111 if (ignore_enoent
&& r
== -ENOENT
) {
3112 log_debug_errno(r
, "Failed to open \"%s\", ignoring: %m", fn
);
3116 return log_error_errno(r
, "Failed to open '%s': %m", fn
);
3118 log_debug("Reading config file \"%s\"…", fn
);
3123 _cleanup_free_
char *line
= NULL
;
3124 bool invalid_line
= false;
3128 k
= read_line(f
, LONG_LINE_MAX
, &line
);
3130 return log_error_errno(k
, "Failed to read '%s': %m", fn
);
3137 if (IN_SET(*l
, 0, '#'))
3140 k
= parse_line(fn
, v
, l
, &invalid_line
, &uid_cache
, &gid_cache
);
3143 /* Allow reporting with a special code if the caller requested this */
3144 *invalid_config
= true;
3146 /* The first error becomes our return value */
3151 /* we have to determine age parameter for each entry of type X */
3152 ORDERED_HASHMAP_FOREACH(i
, globs
, iterator
) {
3154 Item
*j
, *candidate_item
= NULL
;
3156 if (i
->type
!= IGNORE_DIRECTORY_PATH
)
3159 ORDERED_HASHMAP_FOREACH(j
, items
, iter
) {
3160 if (!IN_SET(j
->type
, CREATE_DIRECTORY
, TRUNCATE_DIRECTORY
, CREATE_SUBVOLUME
, CREATE_SUBVOLUME_INHERIT_QUOTA
, CREATE_SUBVOLUME_NEW_QUOTA
))
3163 if (path_equal(j
->path
, i
->path
)) {
3168 if ((!candidate_item
&& path_startswith(i
->path
, j
->path
)) ||
3169 (candidate_item
&& path_startswith(j
->path
, candidate_item
->path
) && (fnmatch(i
->path
, j
->path
, FNM_PATHNAME
| FNM_PERIOD
) == 0)))
3173 if (candidate_item
&& candidate_item
->age_set
) {
3174 i
->age
= candidate_item
->age
;
3180 log_error_errno(errno
, "Failed to read from file %s: %m", fn
);
3188 static int parse_arguments(char **config_dirs
, char **args
, bool *invalid_config
) {
3192 STRV_FOREACH(arg
, args
) {
3193 r
= read_config_file(config_dirs
, *arg
, false, invalid_config
);
3201 static int read_config_files(char **config_dirs
, char **args
, bool *invalid_config
) {
3202 _cleanup_strv_free_
char **files
= NULL
;
3203 _cleanup_free_
char *p
= NULL
;
3207 r
= conf_files_list_with_replacement(arg_root
, config_dirs
, arg_replace
, &files
, &p
);
3211 STRV_FOREACH(f
, files
)
3212 if (p
&& path_equal(*f
, p
)) {
3213 log_debug("Parsing arguments at position \"%s\"…", *f
);
3215 r
= parse_arguments(config_dirs
, args
, invalid_config
);
3219 /* Just warn, ignore result otherwise.
3220 * read_config_file() has some debug output, so no need to print anything. */
3221 (void) read_config_file(config_dirs
, *f
, true, invalid_config
);
3226 static int link_parent(ItemArray
*a
) {
3233 /* Finds the closest "parent" item array for the specified item array. Then registers the specified item array
3234 * as child of it, and fills the parent in, linking them both ways. This allows us to later create parents
3235 * before their children, and clean up/remove children before their parents. */
3237 if (a
->n_items
<= 0)
3240 path
= a
->items
[0].path
;
3241 prefix
= newa(char, strlen(path
) + 1);
3242 PATH_FOREACH_PREFIX(prefix
, path
) {
3245 j
= ordered_hashmap_get(items
, prefix
);
3247 j
= ordered_hashmap_get(globs
, prefix
);
3249 r
= set_ensure_put(&j
->children
, NULL
, a
);
3261 DEFINE_PRIVATE_HASH_OPS_WITH_VALUE_DESTRUCTOR(item_array_hash_ops
, char, string_hash_func
, string_compare_func
,
3262 ItemArray
, item_array_free
);
3264 static int run(int argc
, char *argv
[]) {
3265 _cleanup_(loop_device_unrefp
) LoopDevice
*loop_device
= NULL
;
3266 _cleanup_(decrypted_image_unrefp
) DecryptedImage
*decrypted_image
= NULL
;
3267 _cleanup_(umount_and_rmdir_and_freep
) char *unlink_dir
= NULL
;
3268 _cleanup_strv_free_
char **config_dirs
= NULL
;
3269 bool invalid_config
= false;
3273 PHASE_REMOVE_AND_CLEAN
,
3279 r
= parse_argv(argc
, argv
);
3283 log_setup_service();
3285 /* Descending down file system trees might take a lot of fds */
3286 (void) rlimit_nofile_bump(HIGH_RLIMIT_NOFILE
);
3289 r
= user_config_paths(&config_dirs
);
3291 return log_error_errno(r
, "Failed to initialize configuration directory list: %m");
3293 config_dirs
= strv_split_nulstr(CONF_PATHS_NULSTR("tmpfiles.d"));
3298 if (DEBUG_LOGGING
) {
3299 _cleanup_free_
char *t
= NULL
;
3302 STRV_FOREACH(i
, config_dirs
) {
3303 _cleanup_free_
char *j
= NULL
;
3305 j
= path_join(arg_root
, *i
);
3309 if (!strextend(&t
, "\n\t", j
, NULL
))
3313 log_debug("Looking for configuration files in (higher priority first):%s", t
);
3316 if (arg_cat_config
) {
3317 (void) pager_open(arg_pager_flags
);
3319 return cat_config(config_dirs
, argv
+ optind
);
3324 r
= mac_selinux_init();
3331 r
= mount_image_privately_interactively(
3333 DISSECT_IMAGE_REQUIRE_ROOT
|DISSECT_IMAGE_VALIDATE_OS
|DISSECT_IMAGE_RELAX_VAR_CHECK
|DISSECT_IMAGE_FSCK
,
3340 arg_root
= strdup(unlink_dir
);
3345 items
= ordered_hashmap_new(&item_array_hash_ops
);
3346 globs
= ordered_hashmap_new(&item_array_hash_ops
);
3347 if (!items
|| !globs
)
3350 /* If command line arguments are specified along with --replace, read all
3351 * configuration files and insert the positional arguments at the specified
3352 * place. Otherwise, if command line arguments are specified, execute just
3353 * them, and finally, without --replace= or any positional arguments, just
3354 * read configuration and execute it.
3356 if (arg_replace
|| optind
>= argc
)
3357 r
= read_config_files(config_dirs
, argv
+ optind
, &invalid_config
);
3359 r
= parse_arguments(config_dirs
, argv
+ optind
, &invalid_config
);
3363 /* Let's now link up all child/parent relationships */
3364 ORDERED_HASHMAP_FOREACH(a
, items
, iterator
) {
3369 ORDERED_HASHMAP_FOREACH(a
, globs
, iterator
) {
3375 /* If multiple operations are requested, let's first run the remove/clean operations, and only then the create
3376 * operations. i.e. that we first clean out the platform we then build on. */
3377 for (phase
= 0; phase
< _PHASE_MAX
; phase
++) {
3380 if (phase
== PHASE_REMOVE_AND_CLEAN
)
3381 op
= arg_operation
& (OPERATION_REMOVE
|OPERATION_CLEAN
);
3382 else if (phase
== PHASE_CREATE
)
3383 op
= arg_operation
& OPERATION_CREATE
;
3385 assert_not_reached("unexpected phase");
3387 if (op
== 0) /* Nothing requested in this phase */
3390 /* The non-globbing ones usually create things, hence we apply them first */
3391 ORDERED_HASHMAP_FOREACH(a
, items
, iterator
) {
3392 k
= process_item_array(a
, op
);
3393 if (k
< 0 && r
>= 0)
3397 /* The globbing ones usually alter things, hence we apply them second. */
3398 ORDERED_HASHMAP_FOREACH(a
, globs
, iterator
) {
3399 k
= process_item_array(a
, op
);
3400 if (k
< 0 && r
>= 0)
3405 if (ERRNO_IS_RESOURCE(-r
))
3410 return EX_CANTCREAT
;
3414 DEFINE_MAIN_FUNCTION_WITH_POSITIVE_FAILURE(run
);