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"
32 #include "format-util.h"
34 #include "glob-util.h"
39 #include "main-func.h"
41 #include "mountpoint-util.h"
42 #include "offline-passwd.h"
44 #include "parse-util.h"
45 #include "path-lookup.h"
46 #include "path-util.h"
47 #include "pretty-print.h"
48 #include "rlimit-util.h"
50 #include "selinux-util.h"
52 #include "sort-util.h"
53 #include "specifier.h"
54 #include "stat-util.h"
55 #include "stdio-util.h"
56 #include "string-table.h"
57 #include "string-util.h"
59 #include "umask-util.h"
60 #include "user-util.h"
62 /* This reads all files listed in /etc/tmpfiles.d/?*.conf and creates
63 * them in the file system. This is intended to be used to create
64 * properly owned directories beneath /tmp, /var/tmp, /run, which are
65 * volatile and hence need to be recreated on bootup. */
67 typedef enum OperationMask
{
68 OPERATION_CREATE
= 1 << 0,
69 OPERATION_REMOVE
= 1 << 1,
70 OPERATION_CLEAN
= 1 << 2,
73 typedef enum ItemType
{
74 /* These ones take file names */
76 TRUNCATE_FILE
= 'F', /* deprecated: use f+ */
77 CREATE_DIRECTORY
= 'd',
78 TRUNCATE_DIRECTORY
= 'D',
79 CREATE_SUBVOLUME
= 'v',
80 CREATE_SUBVOLUME_INHERIT_QUOTA
= 'q',
81 CREATE_SUBVOLUME_NEW_QUOTA
= 'Q',
84 CREATE_CHAR_DEVICE
= 'c',
85 CREATE_BLOCK_DEVICE
= 'b',
88 /* These ones take globs */
90 EMPTY_DIRECTORY
= 'e',
92 RECURSIVE_SET_XATTR
= 'T',
94 RECURSIVE_SET_ACL
= 'A',
96 RECURSIVE_SET_ATTRIBUTE
= 'H',
98 IGNORE_DIRECTORY_PATH
= 'X',
100 RECURSIVE_REMOVE_PATH
= 'R',
102 RECURSIVE_RELABEL_PATH
= 'Z',
103 ADJUST_MODE
= 'm', /* legacy, 'z' is identical to this */
106 typedef struct Item
{
122 unsigned attribute_value
;
123 unsigned attribute_mask
;
130 bool attribute_set
:1;
132 bool keep_first_level
:1;
134 bool append_or_force
:1;
136 bool allow_failure
:1;
141 typedef struct ItemArray
{
146 struct ItemArray
*parent
;
150 typedef enum DirectoryType
{
158 static bool arg_cat_config
= false;
159 static bool arg_user
= false;
160 static OperationMask arg_operation
= 0;
161 static bool arg_boot
= false;
162 static PagerFlags arg_pager_flags
= 0;
164 static char **arg_include_prefixes
= NULL
;
165 static char **arg_exclude_prefixes
= NULL
;
166 static char *arg_root
= NULL
;
167 static char *arg_replace
= NULL
;
169 #define MAX_DEPTH 256
171 static OrderedHashmap
*items
= NULL
, *globs
= NULL
;
172 static Set
*unix_sockets
= NULL
;
174 STATIC_DESTRUCTOR_REGISTER(items
, ordered_hashmap_freep
);
175 STATIC_DESTRUCTOR_REGISTER(globs
, ordered_hashmap_freep
);
176 STATIC_DESTRUCTOR_REGISTER(unix_sockets
, set_free_freep
);
177 STATIC_DESTRUCTOR_REGISTER(arg_include_prefixes
, freep
);
178 STATIC_DESTRUCTOR_REGISTER(arg_exclude_prefixes
, freep
);
179 STATIC_DESTRUCTOR_REGISTER(arg_root
, freep
);
181 static int specifier_machine_id_safe(char specifier
, const void *data
, const void *userdata
, char **ret
);
182 static int specifier_directory(char specifier
, const void *data
, const void *userdata
, char **ret
);
184 static const Specifier specifier_table
[] = {
185 { 'm', specifier_machine_id_safe
, NULL
},
186 { 'b', specifier_boot_id
, NULL
},
187 { 'H', specifier_host_name
, NULL
},
188 { 'l', specifier_short_host_name
, NULL
},
189 { 'v', specifier_kernel_release
, NULL
},
190 { 'a', specifier_architecture
, NULL
},
191 { 'o', specifier_os_id
, NULL
},
192 { 'w', specifier_os_version_id
, NULL
},
193 { 'B', specifier_os_build_id
, NULL
},
194 { 'W', specifier_os_variant_id
, NULL
},
196 { 'g', specifier_group_name
, NULL
},
197 { 'G', specifier_group_id
, NULL
},
198 { 'U', specifier_user_id
, NULL
},
199 { 'u', specifier_user_name
, NULL
},
200 { 'h', specifier_user_home
, NULL
},
202 { 't', specifier_directory
, UINT_TO_PTR(DIRECTORY_RUNTIME
) },
203 { 'S', specifier_directory
, UINT_TO_PTR(DIRECTORY_STATE
) },
204 { 'C', specifier_directory
, UINT_TO_PTR(DIRECTORY_CACHE
) },
205 { 'L', specifier_directory
, UINT_TO_PTR(DIRECTORY_LOGS
) },
206 { 'T', specifier_tmp_dir
, NULL
},
207 { 'V', specifier_var_tmp_dir
, NULL
},
211 static int specifier_machine_id_safe(char specifier
, const void *data
, const void *userdata
, char **ret
) {
214 /* If /etc/machine_id is missing or empty (e.g. in a chroot environment)
215 * return a recognizable error so that the caller can skip the rule
218 r
= specifier_machine_id(specifier
, data
, userdata
, ret
);
219 if (IN_SET(r
, -ENOENT
, -ENOMEDIUM
))
225 static int specifier_directory(char specifier
, const void *data
, const void *userdata
, char **ret
) {
231 static const struct table_entry paths_system
[] = {
232 [DIRECTORY_RUNTIME
] = { SD_PATH_SYSTEM_RUNTIME
},
233 [DIRECTORY_STATE
] = { SD_PATH_SYSTEM_STATE_PRIVATE
},
234 [DIRECTORY_CACHE
] = { SD_PATH_SYSTEM_STATE_CACHE
},
235 [DIRECTORY_LOGS
] = { SD_PATH_SYSTEM_STATE_LOGS
},
238 static const struct table_entry paths_user
[] = {
239 [DIRECTORY_RUNTIME
] = { SD_PATH_USER_RUNTIME
},
240 [DIRECTORY_STATE
] = { SD_PATH_USER_CONFIGURATION
},
241 [DIRECTORY_CACHE
] = { SD_PATH_USER_STATE_CACHE
},
242 [DIRECTORY_LOGS
] = { SD_PATH_USER_CONFIGURATION
, "log" },
246 const struct table_entry
*paths
;
248 assert_cc(ELEMENTSOF(paths_system
) == ELEMENTSOF(paths_user
));
249 paths
= arg_user
? paths_user
: paths_system
;
251 i
= PTR_TO_UINT(data
);
252 assert(i
< ELEMENTSOF(paths_system
));
254 return sd_path_lookup(paths
[i
].type
, paths
[i
].suffix
, ret
);
257 static int log_unresolvable_specifier(const char *filename
, unsigned line
) {
258 static bool notified
= false;
260 /* In system mode, this is called when /etc is not fully initialized (e.g.
261 * in a chroot environment) where some specifiers are unresolvable. In user
262 * mode, this is called when some variables are not defined. These cases are
263 * not considered as an error so log at LOG_NOTICE only for the first time
264 * and then downgrade this to LOG_DEBUG for the rest. */
267 notified
? LOG_DEBUG
: LOG_NOTICE
,
269 "Failed to resolve specifier: %s, skipping",
270 arg_user
? "Required $XDG_... variable not defined" : "uninitialized /etc detected");
273 log_notice("All rules containing unresolvable specifiers will be skipped.");
279 static int user_config_paths(char*** ret
) {
280 _cleanup_strv_free_
char **config_dirs
= NULL
, **data_dirs
= NULL
;
281 _cleanup_free_
char *persistent_config
= NULL
, *runtime_config
= NULL
, *data_home
= NULL
;
282 _cleanup_strv_free_
char **res
= NULL
;
285 r
= xdg_user_dirs(&config_dirs
, &data_dirs
);
289 r
= xdg_user_config_dir(&persistent_config
, "/user-tmpfiles.d");
290 if (r
< 0 && r
!= -ENXIO
)
293 r
= xdg_user_runtime_dir(&runtime_config
, "/user-tmpfiles.d");
294 if (r
< 0 && r
!= -ENXIO
)
297 r
= xdg_user_data_dir(&data_home
, "/user-tmpfiles.d");
298 if (r
< 0 && r
!= -ENXIO
)
301 r
= strv_extend_strv_concat(&res
, config_dirs
, "/user-tmpfiles.d");
305 r
= strv_extend(&res
, persistent_config
);
309 r
= strv_extend(&res
, runtime_config
);
313 r
= strv_extend(&res
, data_home
);
317 r
= strv_extend_strv_concat(&res
, data_dirs
, "/user-tmpfiles.d");
321 r
= path_strv_make_absolute_cwd(res
);
325 *ret
= TAKE_PTR(res
);
329 static bool needs_glob(ItemType t
) {
333 IGNORE_DIRECTORY_PATH
,
335 RECURSIVE_REMOVE_PATH
,
339 RECURSIVE_RELABEL_PATH
,
345 RECURSIVE_SET_ATTRIBUTE
);
348 static bool takes_ownership(ItemType t
) {
356 CREATE_SUBVOLUME_INHERIT_QUOTA
,
357 CREATE_SUBVOLUME_NEW_QUOTA
,
365 IGNORE_DIRECTORY_PATH
,
367 RECURSIVE_REMOVE_PATH
);
370 static struct Item
* find_glob(OrderedHashmap
*h
, const char *match
) {
374 ORDERED_HASHMAP_FOREACH(j
, h
, i
) {
377 for (n
= 0; n
< j
->n_items
; n
++) {
378 Item
*item
= j
->items
+ n
;
380 if (fnmatch(item
->path
, match
, FNM_PATHNAME
|FNM_PERIOD
) == 0)
388 static int load_unix_sockets(void) {
389 _cleanup_set_free_free_ Set
*sockets
= NULL
;
390 _cleanup_fclose_
FILE *f
= NULL
;
396 /* We maintain a cache of the sockets we found in /proc/net/unix to speed things up a little. */
398 sockets
= set_new(&path_hash_ops
);
402 f
= fopen("/proc/net/unix", "re");
404 return log_full_errno(errno
== ENOENT
? LOG_DEBUG
: LOG_WARNING
, errno
,
405 "Failed to open /proc/net/unix, ignoring: %m");
408 r
= read_line(f
, LONG_LINE_MAX
, NULL
);
410 return log_warning_errno(r
, "Failed to skip /proc/net/unix header line: %m");
412 return log_warning_errno(SYNTHETIC_ERRNO(EIO
), "Premature end of file reading /proc/net/unix.");
415 _cleanup_free_
char *line
= NULL
, *s
= NULL
;
418 r
= read_line(f
, LONG_LINE_MAX
, &line
);
420 return log_warning_errno(r
, "Failed to read /proc/net/unix line, ignoring: %m");
421 if (r
== 0) /* EOF */
424 p
= strchr(line
, ':');
432 p
+= strspn(p
, WHITESPACE
);
433 p
+= strcspn(p
, WHITESPACE
); /* skip one more word */
434 p
+= strspn(p
, WHITESPACE
);
443 path_simplify(s
, false);
445 r
= set_consume(sockets
, s
);
449 return log_warning_errno(r
, "Failed to add AF_UNIX socket to set, ignoring: %m");
454 unix_sockets
= TAKE_PTR(sockets
);
458 static bool unix_socket_alive(const char *fn
) {
461 if (load_unix_sockets() < 0)
462 return true; /* We don't know, so assume yes */
464 return !!set_get(unix_sockets
, (char*) fn
);
467 static DIR* xopendirat_nomod(int dirfd
, const char *path
) {
470 dir
= xopendirat(dirfd
, path
, O_NOFOLLOW
|O_NOATIME
);
474 log_debug_errno(errno
, "Cannot open %sdirectory \"%s\": %m", dirfd
== AT_FDCWD
? "" : "sub", path
);
478 dir
= xopendirat(dirfd
, path
, O_NOFOLLOW
);
480 log_debug_errno(errno
, "Cannot open %sdirectory \"%s\": %m", dirfd
== AT_FDCWD
? "" : "sub", path
);
485 static DIR* opendir_nomod(const char *path
) {
486 return xopendirat_nomod(AT_FDCWD
, path
);
489 static int dir_cleanup(
493 const struct stat
*ds
,
498 bool keep_this_level
) {
501 bool deleted
= false;
504 FOREACH_DIRENT_ALL(dent
, d
, break) {
507 _cleanup_free_
char *sub_path
= NULL
;
509 if (dot_or_dot_dot(dent
->d_name
))
512 if (fstatat(dirfd(d
), dent
->d_name
, &s
, AT_SYMLINK_NOFOLLOW
) < 0) {
516 /* FUSE, NFS mounts, SELinux might return EACCES */
517 r
= log_full_errno(errno
== EACCES
? LOG_DEBUG
: LOG_ERR
, errno
,
518 "stat(%s/%s) failed: %m", p
, dent
->d_name
);
522 /* Stay on the same filesystem */
523 if (s
.st_dev
!= rootdev
) {
524 log_debug("Ignoring \"%s/%s\": different filesystem.", p
, dent
->d_name
);
528 /* Try to detect bind mounts of the same filesystem instance; they
529 * do not differ in device major/minors. This type of query is not
530 * supported on all kernels or filesystem types though. */
531 if (S_ISDIR(s
.st_mode
)) {
534 q
= fd_is_mount_point(dirfd(d
), dent
->d_name
, 0);
536 log_debug_errno(q
, "Failed to determine whether \"%s/%s\" is a mount point, ignoring: %m", p
, dent
->d_name
);
538 log_debug("Ignoring \"%s/%s\": different mount of the same filesystem.", p
, dent
->d_name
);
543 sub_path
= path_join(p
, dent
->d_name
);
549 /* Is there an item configured for this path? */
550 if (ordered_hashmap_get(items
, sub_path
)) {
551 log_debug("Ignoring \"%s\": a separate entry exists.", sub_path
);
555 if (find_glob(globs
, sub_path
)) {
556 log_debug("Ignoring \"%s\": a separate glob exists.", sub_path
);
560 if (S_ISDIR(s
.st_mode
)) {
561 _cleanup_closedir_
DIR *sub_dir
= NULL
;
564 streq(dent
->d_name
, "lost+found") &&
566 log_debug("Ignoring directory \"%s\".", sub_path
);
571 log_warning("Reached max depth on \"%s\".", sub_path
);
575 sub_dir
= xopendirat_nomod(dirfd(d
), dent
->d_name
);
578 r
= log_warning_errno(errno
, "Opening directory \"%s\" failed, ignoring: %m", sub_path
);
583 if (flock(dirfd(sub_dir
), LOCK_EX
|LOCK_NB
) < 0) {
584 log_debug_errno(errno
, "Couldn't acquire shared BSD lock on directory \"%s\", skipping: %m", p
);
588 q
= dir_cleanup(i
, sub_path
, sub_dir
, &s
, cutoff
, rootdev
, false, maxdepth
-1, false);
593 /* Note: if you are wondering why we don't support the sticky bit for excluding
594 * directories from cleaning like we do it for other file system objects: well, the
595 * sticky bit already has a meaning for directories, so we don't want to overload
598 if (keep_this_level
) {
599 log_debug("Keeping directory \"%s\".", sub_path
);
603 /* Ignore ctime, we change it when deleting */
604 age
= timespec_load(&s
.st_mtim
);
606 char a
[FORMAT_TIMESTAMP_MAX
];
607 /* Follows spelling in stat(1). */
608 log_debug("Directory \"%s\": modify time %s is too new.",
610 format_timestamp_us(a
, sizeof(a
), age
));
614 age
= timespec_load(&s
.st_atim
);
616 char a
[FORMAT_TIMESTAMP_MAX
];
617 log_debug("Directory \"%s\": access time %s is too new.",
619 format_timestamp_us(a
, sizeof(a
), age
));
623 log_debug("Removing directory \"%s\".", sub_path
);
624 if (unlinkat(dirfd(d
), dent
->d_name
, AT_REMOVEDIR
) < 0)
625 if (!IN_SET(errno
, ENOENT
, ENOTEMPTY
))
626 r
= log_warning_errno(errno
, "Failed to remove directory \"%s\", ignoring: %m", sub_path
);
629 /* Skip files for which the sticky bit is set. These are semantics we define, and are
630 * unknown elsewhere. See XDG_RUNTIME_DIR specification for details. */
631 if (s
.st_mode
& S_ISVTX
) {
632 log_debug("Skipping \"%s\": sticky bit set.", sub_path
);
637 S_ISREG(s
.st_mode
) &&
639 STR_IN_SET(dent
->d_name
,
643 log_debug("Skipping \"%s\".", sub_path
);
647 /* Ignore sockets that are listed in /proc/net/unix */
648 if (S_ISSOCK(s
.st_mode
) && unix_socket_alive(sub_path
)) {
649 log_debug("Skipping \"%s\": live socket.", sub_path
);
653 /* Ignore device nodes */
654 if (S_ISCHR(s
.st_mode
) || S_ISBLK(s
.st_mode
)) {
655 log_debug("Skipping \"%s\": a device.", sub_path
);
659 /* Keep files on this level around if this is requested */
660 if (keep_this_level
) {
661 log_debug("Keeping \"%s\".", sub_path
);
665 age
= timespec_load(&s
.st_mtim
);
667 char a
[FORMAT_TIMESTAMP_MAX
];
668 /* Follows spelling in stat(1). */
669 log_debug("File \"%s\": modify time %s is too new.",
671 format_timestamp_us(a
, sizeof(a
), age
));
675 age
= timespec_load(&s
.st_atim
);
677 char a
[FORMAT_TIMESTAMP_MAX
];
678 log_debug("File \"%s\": access time %s is too new.",
680 format_timestamp_us(a
, sizeof(a
), age
));
684 age
= timespec_load(&s
.st_ctim
);
686 char a
[FORMAT_TIMESTAMP_MAX
];
687 log_debug("File \"%s\": change time %s is too new.",
689 format_timestamp_us(a
, sizeof(a
), age
));
693 log_debug("Removing \"%s\".", sub_path
);
694 if (unlinkat(dirfd(d
), dent
->d_name
, 0) < 0)
696 r
= log_warning_errno(errno
, "Failed to remove \"%s\", ignoring: %m", sub_path
);
704 char a
[FORMAT_TIMESTAMP_MAX
], b
[FORMAT_TIMESTAMP_MAX
];
707 age1
= timespec_load(&ds
->st_atim
);
708 age2
= timespec_load(&ds
->st_mtim
);
710 log_debug("Restoring access and modification time on \"%s\": %s, %s",
712 format_timestamp_us(a
, sizeof(a
), age1
),
713 format_timestamp_us(b
, sizeof(b
), age2
));
715 /* Restore original directory timestamps */
716 if (futimens(dirfd(d
), (struct timespec
[]) {
719 log_warning_errno(errno
, "Failed to revert timestamps of '%s', ignoring: %m", p
);
725 static bool dangerous_hardlinks(void) {
726 _cleanup_free_
char *value
= NULL
;
727 static int cached
= -1;
730 /* Check whether the fs.protected_hardlinks sysctl is on. If we can't determine it we assume its off, as that's
731 * what the upstream default is. */
736 r
= read_one_line_file("/proc/sys/fs/protected_hardlinks", &value
);
738 log_debug_errno(r
, "Failed to read fs.protected_hardlinks sysctl: %m");
742 r
= parse_boolean(value
);
744 log_debug_errno(r
, "Failed to parse fs.protected_hardlinks sysctl: %m");
752 static bool hardlink_vulnerable(const struct stat
*st
) {
755 return !S_ISDIR(st
->st_mode
) && st
->st_nlink
> 1 && dangerous_hardlinks();
758 static mode_t
process_mask_perms(mode_t mode
, mode_t current
) {
760 if ((current
& 0111) == 0)
762 if ((current
& 0222) == 0)
764 if ((current
& 0444) == 0)
766 if (!S_ISDIR(current
))
767 mode
&= ~07000; /* remove sticky/sgid/suid bit, unless directory */
772 static int fd_set_perms(Item
*i
, int fd
, const char *path
, const struct stat
*st
) {
781 if (!i
->mode_set
&& !i
->uid_set
&& !i
->gid_set
)
785 if (fstat(fd
, &stbuf
) < 0)
786 return log_error_errno(errno
, "fstat(%s) failed: %m", path
);
790 if (hardlink_vulnerable(st
))
791 return log_error_errno(SYNTHETIC_ERRNO(EPERM
),
792 "Refusing to set permissions on hardlinked file %s while the fs.protected_hardlinks sysctl is turned off.",
795 /* Do we need a chown()? */
797 (i
->uid_set
&& i
->uid
!= st
->st_uid
) ||
798 (i
->gid_set
&& i
->gid
!= st
->st_gid
);
800 /* Calculate the mode to apply */
801 new_mode
= i
->mode_set
? (i
->mask_perms
?
802 process_mask_perms(i
->mode
, st
->st_mode
) :
804 (st
->st_mode
& 07777);
806 if (i
->mode_set
&& do_chown
) {
807 /* Before we issue the chmod() let's reduce the access mode to the common bits of the old and
808 * the new mode. That way there's no time window where the file exists under the old owner
809 * with more than the old access modes — and not under the new owner with more than the new
810 * access modes either. */
812 if (S_ISLNK(st
->st_mode
))
813 log_debug("Skipping temporary mode fix for symlink %s.", path
);
815 mode_t m
= new_mode
& st
->st_mode
; /* Mask new mode by old mode */
817 if (((m
^ st
->st_mode
) & 07777) == 0)
818 log_debug("\"%s\" matches temporary mode %o already.", path
, m
);
820 log_debug("Temporarily changing \"%s\" to mode %o.", path
, m
);
821 if (fchmod_opath(fd
, m
) < 0)
822 return log_error_errno(errno
, "fchmod() of %s failed: %m", path
);
828 log_debug("Changing \"%s\" to owner "UID_FMT
":"GID_FMT
,
830 i
->uid_set
? i
->uid
: UID_INVALID
,
831 i
->gid_set
? i
->gid
: GID_INVALID
);
835 i
->uid_set
? i
->uid
: UID_INVALID
,
836 i
->gid_set
? i
->gid
: GID_INVALID
,
838 return log_error_errno(errno
, "fchownat() of %s failed: %m", path
);
841 /* Now, apply the final mode. We do this in two cases: when the user set a mode explicitly, or after a
842 * chown(), since chown()'s mangle the access mode in regards to sgid/suid in some conditions. */
843 if (i
->mode_set
|| do_chown
) {
844 if (S_ISLNK(st
->st_mode
))
845 log_debug("Skipping mode fix for symlink %s.", path
);
847 /* Check if the chmod() is unnecessary. Note that if we did a chown() before we always
848 * chmod() here again, since it might have mangled the bits. */
849 if (!do_chown
&& ((new_mode
^ st
->st_mode
) & 07777) == 0)
850 log_debug("\"%s\" matches mode %o already.", path
, new_mode
);
852 log_debug("Changing \"%s\" to mode %o.", path
, new_mode
);
853 if (fchmod_opath(fd
, new_mode
) < 0)
854 return log_error_errno(errno
, "fchmod() of %s failed: %m", path
);
860 return label_fix(path
, 0);
863 static int path_open_parent_safe(const char *path
) {
864 _cleanup_free_
char *dn
= NULL
;
867 if (path_equal(path
, "/") || !path_is_normalized(path
))
868 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
869 "Failed to open parent of '%s': invalid path.",
872 dn
= dirname_malloc(path
);
876 r
= chase_symlinks(dn
, arg_root
, CHASE_SAFE
|CHASE_WARN
, NULL
, &fd
);
877 if (r
< 0 && r
!= -ENOLINK
)
878 return log_error_errno(r
, "Failed to validate path %s: %m", path
);
880 return r
< 0 ? r
: fd
;
883 static int path_open_safe(const char *path
) {
886 /* path_open_safe() returns a file descriptor opened with O_PATH after
887 * verifying that the path doesn't contain unsafe transitions, except
888 * for its final component as the function does not follow symlink. */
892 if (!path_is_normalized(path
))
893 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
894 "Failed to open invalid path '%s'.",
897 r
= chase_symlinks(path
, arg_root
, CHASE_SAFE
|CHASE_WARN
|CHASE_NOFOLLOW
, NULL
, &fd
);
898 if (r
< 0 && r
!= -ENOLINK
)
899 return log_error_errno(r
, "Failed to validate path %s: %m", path
);
901 return r
< 0 ? r
: fd
;
904 static int path_set_perms(Item
*i
, const char *path
) {
905 _cleanup_close_
int fd
= -1;
910 fd
= path_open_safe(path
);
914 return fd_set_perms(i
, fd
, path
, NULL
);
917 static int parse_xattrs_from_arg(Item
*i
) {
927 _cleanup_free_
char *name
= NULL
, *value
= NULL
, *xattr
= NULL
;
929 r
= extract_first_word(&p
, &xattr
, NULL
, EXTRACT_UNQUOTE
|EXTRACT_CUNESCAPE
);
931 log_warning_errno(r
, "Failed to parse extended attribute '%s', ignoring: %m", p
);
935 r
= split_pair(xattr
, "=", &name
, &value
);
937 log_warning_errno(r
, "Failed to parse extended attribute, ignoring: %s", xattr
);
941 if (isempty(name
) || isempty(value
)) {
942 log_warning("Malformed extended attribute found, ignoring: %s", xattr
);
946 if (strv_push_pair(&i
->xattrs
, name
, value
) < 0)
955 static int fd_set_xattrs(Item
*i
, int fd
, const char *path
, const struct stat
*st
) {
956 char procfs_path
[STRLEN("/proc/self/fd/") + DECIMAL_STR_MAX(int)];
957 char **name
, **value
;
963 xsprintf(procfs_path
, "/proc/self/fd/%i", fd
);
965 STRV_FOREACH_PAIR(name
, value
, i
->xattrs
) {
966 log_debug("Setting extended attribute '%s=%s' on %s.", *name
, *value
, path
);
967 if (setxattr(procfs_path
, *name
, *value
, strlen(*value
), 0) < 0)
968 return log_error_errno(errno
, "Setting extended attribute %s=%s on %s failed: %m",
969 *name
, *value
, path
);
974 static int path_set_xattrs(Item
*i
, const char *path
) {
975 _cleanup_close_
int fd
= -1;
980 fd
= path_open_safe(path
);
984 return fd_set_xattrs(i
, fd
, path
, NULL
);
987 static int parse_acls_from_arg(Item
*item
) {
993 /* If append_or_force (= modify) is set, we will not modify the acl
994 * afterwards, so the mask can be added now if necessary. */
996 r
= parse_acl(item
->argument
, &item
->acl_access
, &item
->acl_default
, !item
->append_or_force
);
998 log_warning_errno(r
, "Failed to parse ACL \"%s\": %m. Ignoring", item
->argument
);
1000 log_warning_errno(SYNTHETIC_ERRNO(ENOSYS
), "ACLs are not supported. Ignoring");
1007 static int path_set_acl(const char *path
, const char *pretty
, acl_type_t type
, acl_t acl
, bool modify
) {
1008 _cleanup_(acl_free_charpp
) char *t
= NULL
;
1009 _cleanup_(acl_freep
) acl_t dup
= NULL
;
1012 /* Returns 0 for success, positive error if already warned,
1013 * negative error otherwise. */
1016 r
= acls_for_file(path
, type
, acl
, &dup
);
1020 r
= calc_acl_mask_if_needed(&dup
);
1028 /* the mask was already added earlier if needed */
1031 r
= add_base_acls_if_needed(&dup
, path
);
1035 t
= acl_to_any_text(dup
, NULL
, ',', TEXT_ABBREVIATE
);
1036 log_debug("Setting %s ACL %s on %s.",
1037 type
== ACL_TYPE_ACCESS
? "access" : "default",
1040 r
= acl_set_file(path
, type
, dup
);
1042 /* Return positive to indicate we already warned */
1043 return -log_error_errno(errno
,
1044 "Setting %s ACL \"%s\" on %s failed: %m",
1045 type
== ACL_TYPE_ACCESS
? "access" : "default",
1052 static int fd_set_acls(Item
*item
, int fd
, const char *path
, const struct stat
*st
) {
1055 char procfs_path
[STRLEN("/proc/self/fd/") + DECIMAL_STR_MAX(int)];
1063 if (fstat(fd
, &stbuf
) < 0)
1064 return log_error_errno(errno
, "fstat(%s) failed: %m", path
);
1068 if (hardlink_vulnerable(st
))
1069 return log_error_errno(SYNTHETIC_ERRNO(EPERM
),
1070 "Refusing to set ACLs on hardlinked file %s while the fs.protected_hardlinks sysctl is turned off.",
1073 if (S_ISLNK(st
->st_mode
)) {
1074 log_debug("Skipping ACL fix for symlink %s.", path
);
1078 xsprintf(procfs_path
, "/proc/self/fd/%i", fd
);
1080 if (item
->acl_access
)
1081 r
= path_set_acl(procfs_path
, path
, ACL_TYPE_ACCESS
, item
->acl_access
, item
->append_or_force
);
1083 /* set only default acls to folders */
1084 if (r
== 0 && item
->acl_default
&& S_ISDIR(st
->st_mode
))
1085 r
= path_set_acl(procfs_path
, path
, ACL_TYPE_DEFAULT
, item
->acl_default
, item
->append_or_force
);
1088 return -r
; /* already warned */
1090 /* The above procfs paths don't work if /proc is not mounted. */
1091 if (r
== -ENOENT
&& proc_mounted() == 0)
1094 if (r
== -EOPNOTSUPP
) {
1095 log_debug_errno(r
, "ACLs not supported by file system at %s", path
);
1099 return log_error_errno(r
, "ACL operation on \"%s\" failed: %m", path
);
1104 static int path_set_acls(Item
*item
, const char *path
) {
1107 _cleanup_close_
int fd
= -1;
1112 fd
= path_open_safe(path
);
1116 r
= fd_set_acls(item
, fd
, path
, NULL
);
1121 static int parse_attribute_from_arg(Item
*item
) {
1123 static const struct {
1127 { 'A', FS_NOATIME_FL
}, /* do not update atime */
1128 { 'S', FS_SYNC_FL
}, /* Synchronous updates */
1129 { 'D', FS_DIRSYNC_FL
}, /* dirsync behaviour (directories only) */
1130 { 'a', FS_APPEND_FL
}, /* writes to file may only append */
1131 { 'c', FS_COMPR_FL
}, /* Compress file */
1132 { 'd', FS_NODUMP_FL
}, /* do not dump file */
1133 { 'e', FS_EXTENT_FL
}, /* Extents */
1134 { 'i', FS_IMMUTABLE_FL
}, /* Immutable file */
1135 { 'j', FS_JOURNAL_DATA_FL
}, /* Reserved for ext3 */
1136 { 's', FS_SECRM_FL
}, /* Secure deletion */
1137 { 'u', FS_UNRM_FL
}, /* Undelete */
1138 { 't', FS_NOTAIL_FL
}, /* file tail should not be merged */
1139 { 'T', FS_TOPDIR_FL
}, /* Top of directory hierarchies */
1140 { 'C', FS_NOCOW_FL
}, /* Do not cow file */
1141 { 'P', FS_PROJINHERIT_FL
}, /* Inherit the quota project ID */
1150 unsigned value
= 0, mask
= 0;
1160 } else if (*p
== '-') {
1163 } else if (*p
== '=') {
1169 if (isempty(p
) && mode
!= MODE_SET
)
1170 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
1171 "Setting file attribute on '%s' needs an attribute specification.",
1174 for (; p
&& *p
; p
++) {
1177 for (i
= 0; i
< ELEMENTSOF(attributes
); i
++)
1178 if (*p
== attributes
[i
].character
)
1181 if (i
>= ELEMENTSOF(attributes
))
1182 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
1183 "Unknown file attribute '%c' on '%s'.",
1186 v
= attributes
[i
].value
;
1188 SET_FLAG(value
, v
, IN_SET(mode
, MODE_ADD
, MODE_SET
));
1193 if (mode
== MODE_SET
)
1194 mask
|= CHATTR_ALL_FL
;
1198 item
->attribute_mask
= mask
;
1199 item
->attribute_value
= value
;
1200 item
->attribute_set
= true;
1205 static int fd_set_attribute(Item
*item
, int fd
, const char *path
, const struct stat
*st
) {
1206 _cleanup_close_
int procfs_fd
= -1;
1215 if (!item
->attribute_set
|| item
->attribute_mask
== 0)
1219 if (fstat(fd
, &stbuf
) < 0)
1220 return log_error_errno(errno
, "fstat(%s) failed: %m", path
);
1224 /* Issuing the file attribute ioctls on device nodes is not
1225 * safe, as that will be delivered to the drivers, not the
1226 * file system containing the device node. */
1227 if (!S_ISREG(st
->st_mode
) && !S_ISDIR(st
->st_mode
))
1228 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
1229 "Setting file flags is only supported on regular files and directories, cannot set on '%s'.",
1232 f
= item
->attribute_value
& item
->attribute_mask
;
1234 /* Mask away directory-specific flags */
1235 if (!S_ISDIR(st
->st_mode
))
1236 f
&= ~FS_DIRSYNC_FL
;
1238 procfs_fd
= fd_reopen(fd
, O_RDONLY
|O_CLOEXEC
|O_NOATIME
);
1240 return log_error_errno(procfs_fd
, "Failed to re-open '%s': %m", path
);
1242 r
= chattr_fd(procfs_fd
, f
, item
->attribute_mask
, NULL
);
1244 log_full_errno(IN_SET(r
, -ENOTTY
, -EOPNOTSUPP
) ? LOG_DEBUG
: LOG_WARNING
,
1246 "Cannot set file attribute for '%s', value=0x%08x, mask=0x%08x, ignoring: %m",
1247 path
, item
->attribute_value
, item
->attribute_mask
);
1252 static int path_set_attribute(Item
*item
, const char *path
) {
1253 _cleanup_close_
int fd
= -1;
1255 if (!item
->attribute_set
|| item
->attribute_mask
== 0)
1258 fd
= path_open_safe(path
);
1262 return fd_set_attribute(item
, fd
, path
, NULL
);
1265 static int write_one_file(Item
*i
, const char *path
) {
1266 _cleanup_close_
int fd
= -1, dir_fd
= -1;
1272 assert(i
->argument
);
1273 assert(i
->type
== WRITE_FILE
);
1275 /* Validate the path and keep the fd on the directory for opening the
1276 * file so we're sure that it can't be changed behind our back. */
1277 dir_fd
= path_open_parent_safe(path
);
1281 bn
= basename(path
);
1283 flags
= O_NONBLOCK
|O_CLOEXEC
|O_WRONLY
|O_NOCTTY
;
1285 /* Follows symlinks */
1286 fd
= openat(dir_fd
, bn
, i
->append_or_force
? flags
|O_APPEND
: flags
, i
->mode
);
1288 if (errno
== ENOENT
) {
1289 log_debug_errno(errno
, "Not writing missing file \"%s\": %m", path
);
1292 return log_error_errno(errno
, "Failed to open file \"%s\": %m", path
);
1295 /* 'w' is allowed to write into any kind of files. */
1296 log_debug("Writing to \"%s\".", path
);
1298 r
= loop_write(fd
, i
->argument
, strlen(i
->argument
), false);
1300 return log_error_errno(r
, "Failed to write file \"%s\": %m", path
);
1302 return fd_set_perms(i
, fd
, path
, NULL
);
1305 static int create_file(Item
*i
, const char *path
) {
1306 _cleanup_close_
int fd
= -1, dir_fd
= -1;
1307 struct stat stbuf
, *st
= NULL
;
1313 assert(i
->type
== CREATE_FILE
);
1315 /* 'f' operates on regular files exclusively. */
1317 /* Validate the path and keep the fd on the directory for opening the
1318 * file so we're sure that it can't be changed behind our back. */
1319 dir_fd
= path_open_parent_safe(path
);
1323 bn
= basename(path
);
1325 RUN_WITH_UMASK(0000) {
1326 mac_selinux_create_file_prepare(path
, S_IFREG
);
1327 fd
= openat(dir_fd
, bn
, O_CREAT
|O_EXCL
|O_NOFOLLOW
|O_NONBLOCK
|O_CLOEXEC
|O_WRONLY
|O_NOCTTY
, i
->mode
);
1328 mac_selinux_create_file_clear();
1332 /* Even on a read-only filesystem, open(2) returns EEXIST if the
1333 * file already exists. It returns EROFS only if it needs to
1334 * create the file. */
1335 if (errno
!= EEXIST
)
1336 return log_error_errno(errno
, "Failed to create file %s: %m", path
);
1338 /* Re-open the file. At that point it must exist since open(2)
1339 * failed with EEXIST. We still need to check if the perms/mode
1340 * need to be changed. For read-only filesystems, we let
1341 * fd_set_perms() report the error if the perms need to be
1343 fd
= openat(dir_fd
, bn
, O_NOFOLLOW
|O_CLOEXEC
|O_PATH
, i
->mode
);
1345 return log_error_errno(errno
, "Failed to re-open file %s: %m", path
);
1347 if (fstat(fd
, &stbuf
) < 0)
1348 return log_error_errno(errno
, "stat(%s) failed: %m", path
);
1350 if (!S_ISREG(stbuf
.st_mode
)) {
1351 log_error("%s exists and is not a regular file.", path
);
1358 log_debug("\"%s\" has been created.", path
);
1361 log_debug("Writing to \"%s\".", path
);
1363 r
= loop_write(fd
, i
->argument
, strlen(i
->argument
), false);
1365 return log_error_errno(r
, "Failed to write file \"%s\": %m", path
);
1369 return fd_set_perms(i
, fd
, path
, st
);
1372 static int truncate_file(Item
*i
, const char *path
) {
1373 _cleanup_close_
int fd
= -1, dir_fd
= -1;
1374 struct stat stbuf
, *st
= NULL
;
1381 assert(i
->type
== TRUNCATE_FILE
|| (i
->type
== CREATE_FILE
&& i
->append_or_force
));
1383 /* We want to operate on regular file exclusively especially since
1384 * O_TRUNC is unspecified if the file is neither a regular file nor a
1385 * fifo nor a terminal device. Therefore we first open the file and make
1386 * sure it's a regular one before truncating it. */
1388 /* Validate the path and keep the fd on the directory for opening the
1389 * file so we're sure that it can't be changed behind our back. */
1390 dir_fd
= path_open_parent_safe(path
);
1394 bn
= basename(path
);
1396 RUN_WITH_UMASK(0000) {
1397 mac_selinux_create_file_prepare(path
, S_IFREG
);
1398 fd
= openat(dir_fd
, bn
, O_CREAT
|O_NOFOLLOW
|O_NONBLOCK
|O_CLOEXEC
|O_WRONLY
|O_NOCTTY
, i
->mode
);
1399 mac_selinux_create_file_clear();
1404 return log_error_errno(errno
, "Failed to open/create file %s: %m", path
);
1406 /* On a read-only filesystem, we don't want to fail if the
1407 * target is already empty and the perms are set. So we still
1408 * proceed with the sanity checks and let the remaining
1409 * operations fail with EROFS if they try to modify the target
1412 fd
= openat(dir_fd
, bn
, O_NOFOLLOW
|O_CLOEXEC
|O_PATH
, i
->mode
);
1414 if (errno
== ENOENT
) {
1415 log_error("Cannot create file %s on a read-only file system.", path
);
1419 return log_error_errno(errno
, "Failed to re-open file %s: %m", path
);
1425 if (fstat(fd
, &stbuf
) < 0)
1426 return log_error_errno(errno
, "stat(%s) failed: %m", path
);
1428 if (!S_ISREG(stbuf
.st_mode
)) {
1429 log_error("%s exists and is not a regular file.", path
);
1433 if (stbuf
.st_size
> 0) {
1434 if (ftruncate(fd
, 0) < 0) {
1435 r
= erofs
? -EROFS
: -errno
;
1436 return log_error_errno(r
, "Failed to truncate file %s: %m", path
);
1441 log_debug("\"%s\" has been created.", path
);
1444 log_debug("Writing to \"%s\".", path
);
1446 r
= loop_write(fd
, i
->argument
, strlen(i
->argument
), false);
1448 r
= erofs
? -EROFS
: r
;
1449 return log_error_errno(r
, "Failed to write file %s: %m", path
);
1453 return fd_set_perms(i
, fd
, path
, st
);
1456 static int copy_files(Item
*i
) {
1457 _cleanup_close_
int dfd
= -1, fd
= -1;
1461 log_debug("Copying tree \"%s\" to \"%s\".", i
->argument
, i
->path
);
1463 bn
= basename(i
->path
);
1465 /* Validate the path and use the returned directory fd for copying the
1466 * target so we're sure that the path can't be changed behind our
1468 dfd
= path_open_parent_safe(i
->path
);
1472 r
= copy_tree_at(AT_FDCWD
, i
->argument
,
1474 i
->uid_set
? i
->uid
: UID_INVALID
,
1475 i
->gid_set
? i
->gid
: GID_INVALID
,
1476 COPY_REFLINK
| COPY_MERGE_EMPTY
| COPY_MAC_CREATE
);
1480 /* If the target already exists on read-only filesystems, trying
1481 * to create the target will not fail with EEXIST but with
1483 if (r
== -EROFS
&& faccessat(dfd
, bn
, F_OK
, AT_SYMLINK_NOFOLLOW
) == 0)
1487 return log_error_errno(r
, "Failed to copy files to %s: %m", i
->path
);
1489 if (stat(i
->argument
, &a
) < 0)
1490 return log_error_errno(errno
, "stat(%s) failed: %m", i
->argument
);
1492 if (fstatat(dfd
, bn
, &b
, AT_SYMLINK_NOFOLLOW
) < 0)
1493 return log_error_errno(errno
, "stat(%s) failed: %m", i
->path
);
1495 if ((a
.st_mode
^ b
.st_mode
) & S_IFMT
) {
1496 log_debug("Can't copy to %s, file exists already and is of different type", i
->path
);
1501 fd
= openat(dfd
, bn
, O_NOFOLLOW
|O_CLOEXEC
|O_PATH
);
1503 return log_error_errno(errno
, "Failed to openat(%s): %m", i
->path
);
1505 return fd_set_perms(i
, fd
, i
->path
, NULL
);
1513 _CREATION_MODE_INVALID
= -1
1516 static const char *const creation_mode_verb_table
[_CREATION_MODE_MAX
] = {
1517 [CREATION_NORMAL
] = "Created",
1518 [CREATION_EXISTING
] = "Found existing",
1519 [CREATION_FORCE
] = "Created replacement",
1522 DEFINE_PRIVATE_STRING_TABLE_LOOKUP_TO_STRING(creation_mode_verb
, CreationMode
);
1524 static int create_directory_or_subvolume(const char *path
, mode_t mode
, bool subvol
, CreationMode
*creation
) {
1525 _cleanup_close_
int pfd
= -1;
1534 pfd
= path_open_parent_safe(path
);
1539 if (btrfs_is_subvol(empty_to_root(arg_root
)) <= 0)
1541 /* Don't create a subvolume unless the root directory is
1542 * one, too. We do this under the assumption that if the
1543 * root directory is just a plain directory (i.e. very
1544 * light-weight), we shouldn't try to split it up into
1545 * subvolumes (i.e. more heavy-weight). Thus, chroot()
1546 * environments and suchlike will get a full brtfs
1547 * subvolume set up below their tree only if they
1548 * specifically set up a btrfs subvolume for the root
1553 RUN_WITH_UMASK((~mode
) & 0777)
1554 r
= btrfs_subvol_make_fd(pfd
, basename(path
));
1559 if (!subvol
|| r
== -ENOTTY
)
1560 RUN_WITH_UMASK(0000)
1561 r
= mkdirat_label(pfd
, basename(path
), mode
);
1566 if (!IN_SET(r
, -EEXIST
, -EROFS
))
1567 return log_error_errno(r
, "Failed to create directory or subvolume \"%s\": %m", path
);
1570 if (k
== -ENOENT
&& r
== -EROFS
)
1571 return log_error_errno(r
, "%s does not exist and cannot be created as the file system is read-only.", path
);
1573 return log_error_errno(k
, "Failed to check if %s exists: %m", path
);
1575 log_warning("\"%s\" already exists and is not a directory.", path
);
1579 *creation
= CREATION_EXISTING
;
1581 *creation
= CREATION_NORMAL
;
1583 log_debug("%s directory \"%s\".", creation_mode_verb_to_string(*creation
), path
);
1585 r
= openat(pfd
, basename(path
), O_NOCTTY
|O_CLOEXEC
|O_DIRECTORY
);
1587 return log_error_errno(errno
, "Failed to open directory '%s': %m", basename(path
));
1592 static int create_directory(Item
*i
, const char *path
) {
1593 _cleanup_close_
int fd
= -1;
1596 assert(IN_SET(i
->type
, CREATE_DIRECTORY
, TRUNCATE_DIRECTORY
));
1598 fd
= create_directory_or_subvolume(path
, i
->mode
, false, NULL
);
1604 return fd_set_perms(i
, fd
, path
, NULL
);
1607 static int create_subvolume(Item
*i
, const char *path
) {
1608 _cleanup_close_
int fd
= -1;
1609 CreationMode creation
;
1613 assert(IN_SET(i
->type
, CREATE_SUBVOLUME
, CREATE_SUBVOLUME_NEW_QUOTA
, CREATE_SUBVOLUME_INHERIT_QUOTA
));
1615 fd
= create_directory_or_subvolume(path
, i
->mode
, true, &creation
);
1621 if (creation
== CREATION_NORMAL
&&
1622 IN_SET(i
->type
, CREATE_SUBVOLUME_NEW_QUOTA
, CREATE_SUBVOLUME_INHERIT_QUOTA
)) {
1623 r
= btrfs_subvol_auto_qgroup_fd(fd
, 0, i
->type
== CREATE_SUBVOLUME_NEW_QUOTA
);
1625 log_debug_errno(r
, "Couldn't adjust quota for subvolume \"%s\" (unsupported fs or dir not a subvolume): %m", i
->path
);
1626 else if (r
== -EROFS
)
1627 log_debug_errno(r
, "Couldn't adjust quota for subvolume \"%s\" (fs is read-only).", i
->path
);
1628 else if (r
== -ENOPROTOOPT
)
1629 log_debug_errno(r
, "Couldn't adjust quota for subvolume \"%s\" (quota support is disabled).", i
->path
);
1631 q
= log_error_errno(r
, "Failed to adjust quota for subvolume \"%s\": %m", i
->path
);
1633 log_debug("Adjusted quota for subvolume \"%s\".", i
->path
);
1635 log_debug("Quota for subvolume \"%s\" already in place, no change made.", i
->path
);
1638 r
= fd_set_perms(i
, fd
, path
, NULL
);
1639 if (q
< 0) /* prefer the quota change error from above */
1645 static int empty_directory(Item
*i
, const char *path
) {
1649 assert(i
->type
== EMPTY_DIRECTORY
);
1651 r
= is_dir(path
, false);
1653 /* Option "e" operates only on existing objects. Do not
1654 * print errors about non-existent files or directories */
1655 log_debug("Skipping missing directory: %s", path
);
1659 return log_error_errno(r
, "is_dir() failed on path %s: %m", path
);
1661 return log_error_errno(SYNTHETIC_ERRNO(EEXIST
),
1662 "'%s' already exists and is not a directory.",
1665 return path_set_perms(i
, path
);
1668 static int create_device(Item
*i
, mode_t file_type
) {
1669 _cleanup_close_
int dfd
= -1, fd
= -1;
1670 CreationMode creation
;
1675 assert(IN_SET(file_type
, S_IFBLK
, S_IFCHR
));
1677 bn
= basename(i
->path
);
1679 /* Validate the path and use the returned directory fd for copying the
1680 * target so we're sure that the path can't be changed behind our
1682 dfd
= path_open_parent_safe(i
->path
);
1686 RUN_WITH_UMASK(0000) {
1687 mac_selinux_create_file_prepare(i
->path
, file_type
);
1688 r
= mknodat(dfd
, bn
, i
->mode
| file_type
, i
->major_minor
);
1689 mac_selinux_create_file_clear();
1695 if (errno
== EPERM
) {
1696 log_debug("We lack permissions, possibly because of cgroup configuration; "
1697 "skipping creation of device node %s.", i
->path
);
1701 if (errno
!= EEXIST
)
1702 return log_error_errno(errno
, "Failed to create device node %s: %m", i
->path
);
1704 if (fstatat(dfd
, bn
, &st
, 0) < 0)
1705 return log_error_errno(errno
, "stat(%s) failed: %m", i
->path
);
1707 if ((st
.st_mode
& S_IFMT
) != file_type
) {
1709 if (i
->append_or_force
) {
1711 RUN_WITH_UMASK(0000) {
1712 mac_selinux_create_file_prepare(i
->path
, file_type
);
1713 /* FIXME: need to introduce mknodat_atomic() */
1714 r
= mknod_atomic(i
->path
, i
->mode
| file_type
, i
->major_minor
);
1715 mac_selinux_create_file_clear();
1719 return log_error_errno(r
, "Failed to create device node \"%s\": %m", i
->path
);
1720 creation
= CREATION_FORCE
;
1722 log_debug("%s is not a device node.", i
->path
);
1726 creation
= CREATION_EXISTING
;
1728 creation
= CREATION_NORMAL
;
1730 log_debug("%s %s device node \"%s\" %u:%u.",
1731 creation_mode_verb_to_string(creation
),
1732 i
->type
== CREATE_BLOCK_DEVICE
? "block" : "char",
1733 i
->path
, major(i
->mode
), minor(i
->mode
));
1735 fd
= openat(dfd
, bn
, O_NOFOLLOW
|O_CLOEXEC
|O_PATH
);
1737 return log_error_errno(errno
, "Failed to openat(%s): %m", i
->path
);
1739 return fd_set_perms(i
, fd
, i
->path
, NULL
);
1742 static int create_fifo(Item
*i
, const char *path
) {
1743 _cleanup_close_
int pfd
= -1, fd
= -1;
1744 CreationMode creation
;
1749 pfd
= path_open_parent_safe(path
);
1753 bn
= basename(path
);
1755 RUN_WITH_UMASK(0000) {
1756 mac_selinux_create_file_prepare(path
, S_IFIFO
);
1757 r
= mkfifoat(pfd
, bn
, i
->mode
);
1758 mac_selinux_create_file_clear();
1762 if (errno
!= EEXIST
)
1763 return log_error_errno(errno
, "Failed to create fifo %s: %m", path
);
1765 if (fstatat(pfd
, bn
, &st
, AT_SYMLINK_NOFOLLOW
) < 0)
1766 return log_error_errno(errno
, "stat(%s) failed: %m", path
);
1768 if (!S_ISFIFO(st
.st_mode
)) {
1770 if (i
->append_or_force
) {
1771 RUN_WITH_UMASK(0000) {
1772 mac_selinux_create_file_prepare(path
, S_IFIFO
);
1773 r
= mkfifoat_atomic(pfd
, bn
, i
->mode
);
1774 mac_selinux_create_file_clear();
1778 return log_error_errno(r
, "Failed to create fifo %s: %m", path
);
1779 creation
= CREATION_FORCE
;
1781 log_warning("\"%s\" already exists and is not a fifo.", path
);
1785 creation
= CREATION_EXISTING
;
1787 creation
= CREATION_NORMAL
;
1789 log_debug("%s fifo \"%s\".", creation_mode_verb_to_string(creation
), path
);
1791 fd
= openat(pfd
, bn
, O_NOFOLLOW
|O_CLOEXEC
|O_PATH
);
1793 return log_error_errno(errno
, "Failed to openat(%s): %m", path
);
1795 return fd_set_perms(i
, fd
, i
->path
, NULL
);
1798 typedef int (*action_t
)(Item
*i
, const char *path
);
1799 typedef int (*fdaction_t
)(Item
*i
, int fd
, const char *path
, const struct stat
*st
);
1801 static int item_do(Item
*i
, int fd
, const char *path
, fdaction_t action
) {
1809 if (fstat(fd
, &st
) < 0) {
1810 r
= log_error_errno(errno
, "fstat() on file failed: %m");
1814 /* This returns the first error we run into, but nevertheless
1816 r
= action(i
, fd
, path
, &st
);
1818 if (S_ISDIR(st
.st_mode
)) {
1819 char procfs_path
[STRLEN("/proc/self/fd/") + DECIMAL_STR_MAX(int)];
1820 _cleanup_closedir_
DIR *d
= NULL
;
1823 /* The passed 'fd' was opened with O_PATH. We need to convert
1824 * it into a 'regular' fd before reading the directory content. */
1825 xsprintf(procfs_path
, "/proc/self/fd/%i", fd
);
1827 d
= opendir(procfs_path
);
1829 log_error_errno(errno
, "Failed to opendir() '%s': %m", procfs_path
);
1835 FOREACH_DIRENT_ALL(de
, d
, q
= -errno
; goto finish
) {
1838 if (dot_or_dot_dot(de
->d_name
))
1841 de_fd
= openat(fd
, de
->d_name
, O_NOFOLLOW
|O_CLOEXEC
|O_PATH
);
1843 q
= log_error_errno(errno
, "Failed to open() file '%s': %m", de
->d_name
);
1845 _cleanup_free_
char *de_path
= NULL
;
1847 de_path
= path_join(path
, de
->d_name
);
1851 /* Pass ownership of dirent fd over */
1852 q
= item_do(i
, de_fd
, de_path
, action
);
1855 if (q
< 0 && r
== 0)
1864 static int glob_item(Item
*i
, action_t action
) {
1865 _cleanup_globfree_ glob_t g
= {
1866 .gl_opendir
= (void *(*)(const char *)) opendir_nomod
,
1871 k
= safe_glob(i
->path
, GLOB_NOSORT
|GLOB_BRACE
, &g
);
1872 if (k
< 0 && k
!= -ENOENT
)
1873 return log_error_errno(k
, "glob(%s) failed: %m", i
->path
);
1875 STRV_FOREACH(fn
, g
.gl_pathv
) {
1877 if (k
< 0 && r
== 0)
1884 static int glob_item_recursively(Item
*i
, fdaction_t action
) {
1885 _cleanup_globfree_ glob_t g
= {
1886 .gl_opendir
= (void *(*)(const char *)) opendir_nomod
,
1891 k
= safe_glob(i
->path
, GLOB_NOSORT
|GLOB_BRACE
, &g
);
1892 if (k
< 0 && k
!= -ENOENT
)
1893 return log_error_errno(k
, "glob(%s) failed: %m", i
->path
);
1895 STRV_FOREACH(fn
, g
.gl_pathv
) {
1896 _cleanup_close_
int fd
= -1;
1898 /* Make sure we won't trigger/follow file object (such as
1899 * device nodes, automounts, ...) pointed out by 'fn' with
1900 * O_PATH. Note, when O_PATH is used, flags other than
1901 * O_CLOEXEC, O_DIRECTORY, and O_NOFOLLOW are ignored. */
1903 fd
= open(*fn
, O_CLOEXEC
|O_NOFOLLOW
|O_PATH
);
1905 log_error_errno(errno
, "Opening '%s' failed: %m", *fn
);
1911 k
= item_do(i
, fd
, *fn
, action
);
1912 if (k
< 0 && r
== 0)
1915 /* we passed fd ownership to the previous call */
1922 static int create_item(Item
*i
) {
1923 CreationMode creation
;
1928 log_debug("Running create action for entry %c %s", (char) i
->type
, i
->path
);
1933 case IGNORE_DIRECTORY_PATH
:
1935 case RECURSIVE_REMOVE_PATH
:
1940 RUN_WITH_UMASK(0000)
1941 (void) mkdir_parents_label(i
->path
, 0755);
1943 if ((i
->type
== CREATE_FILE
&& i
->append_or_force
) || i
->type
== TRUNCATE_FILE
)
1944 r
= truncate_file(i
, i
->path
);
1946 r
= create_file(i
, i
->path
);
1953 RUN_WITH_UMASK(0000)
1954 (void) mkdir_parents_label(i
->path
, 0755);
1962 r
= glob_item(i
, write_one_file
);
1968 case CREATE_DIRECTORY
:
1969 case TRUNCATE_DIRECTORY
:
1970 RUN_WITH_UMASK(0000)
1971 (void) mkdir_parents_label(i
->path
, 0755);
1973 r
= create_directory(i
, i
->path
);
1978 case CREATE_SUBVOLUME
:
1979 case CREATE_SUBVOLUME_INHERIT_QUOTA
:
1980 case CREATE_SUBVOLUME_NEW_QUOTA
:
1981 RUN_WITH_UMASK(0000)
1982 (void) mkdir_parents_label(i
->path
, 0755);
1984 r
= create_subvolume(i
, i
->path
);
1989 case EMPTY_DIRECTORY
:
1990 r
= glob_item(i
, empty_directory
);
1996 RUN_WITH_UMASK(0000)
1997 (void) mkdir_parents_label(i
->path
, 0755);
1999 r
= create_fifo(i
, i
->path
);
2004 case CREATE_SYMLINK
: {
2005 RUN_WITH_UMASK(0000)
2006 (void) mkdir_parents_label(i
->path
, 0755);
2008 mac_selinux_create_file_prepare(i
->path
, S_IFLNK
);
2009 r
= symlink(i
->argument
, i
->path
);
2010 mac_selinux_create_file_clear();
2013 _cleanup_free_
char *x
= NULL
;
2015 if (errno
!= EEXIST
)
2016 return log_error_errno(errno
, "symlink(%s, %s) failed: %m", i
->argument
, i
->path
);
2018 r
= readlink_malloc(i
->path
, &x
);
2019 if (r
< 0 || !streq(i
->argument
, x
)) {
2021 if (i
->append_or_force
) {
2022 mac_selinux_create_file_prepare(i
->path
, S_IFLNK
);
2023 r
= symlink_atomic(i
->argument
, i
->path
);
2024 mac_selinux_create_file_clear();
2026 if (IN_SET(r
, -EISDIR
, -EEXIST
, -ENOTEMPTY
)) {
2027 r
= rm_rf(i
->path
, REMOVE_ROOT
|REMOVE_PHYSICAL
);
2029 return log_error_errno(r
, "rm -fr %s failed: %m", i
->path
);
2031 mac_selinux_create_file_prepare(i
->path
, S_IFLNK
);
2032 r
= symlink(i
->argument
, i
->path
) < 0 ? -errno
: 0;
2033 mac_selinux_create_file_clear();
2036 return log_error_errno(r
, "symlink(%s, %s) failed: %m", i
->argument
, i
->path
);
2038 creation
= CREATION_FORCE
;
2040 log_debug("\"%s\" is not a symlink or does not point to the correct path.", i
->path
);
2044 creation
= CREATION_EXISTING
;
2047 creation
= CREATION_NORMAL
;
2048 log_debug("%s symlink \"%s\".", creation_mode_verb_to_string(creation
), i
->path
);
2052 case CREATE_BLOCK_DEVICE
:
2053 case CREATE_CHAR_DEVICE
:
2054 if (have_effective_cap(CAP_MKNOD
) == 0) {
2055 /* In a container we lack CAP_MKNOD. We shouldn't attempt to create the device node in that
2056 * case to avoid noise, and we don't support virtualized devices in containers anyway. */
2058 log_debug("We lack CAP_MKNOD, skipping creation of device node %s.", i
->path
);
2062 RUN_WITH_UMASK(0000)
2063 (void) mkdir_parents_label(i
->path
, 0755);
2065 r
= create_device(i
, i
->type
== CREATE_BLOCK_DEVICE
? S_IFBLK
: S_IFCHR
);
2073 r
= glob_item(i
, path_set_perms
);
2078 case RECURSIVE_RELABEL_PATH
:
2079 r
= glob_item_recursively(i
, fd_set_perms
);
2085 r
= glob_item(i
, path_set_xattrs
);
2090 case RECURSIVE_SET_XATTR
:
2091 r
= glob_item_recursively(i
, fd_set_xattrs
);
2097 r
= glob_item(i
, path_set_acls
);
2102 case RECURSIVE_SET_ACL
:
2103 r
= glob_item_recursively(i
, fd_set_acls
);
2109 r
= glob_item(i
, path_set_attribute
);
2114 case RECURSIVE_SET_ATTRIBUTE
:
2115 r
= glob_item_recursively(i
, fd_set_attribute
);
2124 static int remove_item_instance(Item
*i
, const char *instance
) {
2132 if (remove(instance
) < 0 && errno
!= ENOENT
)
2133 return log_error_errno(errno
, "rm(%s): %m", instance
);
2137 case RECURSIVE_REMOVE_PATH
:
2138 /* FIXME: we probably should use dir_cleanup() here instead of rm_rf() so that 'x' is honoured. */
2139 log_debug("rm -rf \"%s\"", instance
);
2140 r
= rm_rf(instance
, REMOVE_ROOT
|REMOVE_SUBVOLUME
|REMOVE_PHYSICAL
);
2141 if (r
< 0 && r
!= -ENOENT
)
2142 return log_error_errno(r
, "rm_rf(%s): %m", instance
);
2147 assert_not_reached("wut?");
2153 static int remove_item(Item
*i
) {
2158 log_debug("Running remove action for entry %c %s", (char) i
->type
, i
->path
);
2162 case TRUNCATE_DIRECTORY
:
2163 /* FIXME: we probably should use dir_cleanup() here instead of rm_rf() so that 'x' is honoured. */
2164 log_debug("rm -rf \"%s\"", i
->path
);
2165 r
= rm_rf(i
->path
, REMOVE_PHYSICAL
);
2166 if (r
< 0 && r
!= -ENOENT
)
2167 return log_error_errno(r
, "rm_rf(%s): %m", i
->path
);
2172 case RECURSIVE_REMOVE_PATH
:
2173 return glob_item(i
, remove_item_instance
);
2180 static int clean_item_instance(Item
*i
, const char* instance
) {
2181 _cleanup_closedir_
DIR *d
= NULL
;
2185 char timestamp
[FORMAT_TIMESTAMP_MAX
];
2192 n
= now(CLOCK_REALTIME
);
2196 cutoff
= n
- i
->age
;
2198 d
= opendir_nomod(instance
);
2200 if (IN_SET(errno
, ENOENT
, ENOTDIR
)) {
2201 log_debug_errno(errno
, "Directory \"%s\": %m", instance
);
2205 return log_error_errno(errno
, "Failed to open directory %s: %m", instance
);
2208 if (fstat(dirfd(d
), &s
) < 0)
2209 return log_error_errno(errno
, "stat(%s) failed: %m", i
->path
);
2211 if (!S_ISDIR(s
.st_mode
))
2212 return log_error_errno(SYNTHETIC_ERRNO(ENOTDIR
),
2213 "%s is not a directory.", i
->path
);
2215 if (fstatat(dirfd(d
), "..", &ps
, AT_SYMLINK_NOFOLLOW
) != 0)
2216 return log_error_errno(errno
, "stat(%s/..) failed: %m", i
->path
);
2218 mountpoint
= s
.st_dev
!= ps
.st_dev
|| s
.st_ino
== ps
.st_ino
;
2220 log_debug("Cleanup threshold for %s \"%s\" is %s",
2221 mountpoint
? "mount point" : "directory",
2223 format_timestamp_us(timestamp
, sizeof(timestamp
), cutoff
));
2225 return dir_cleanup(i
, instance
, d
, &s
, cutoff
, s
.st_dev
, mountpoint
,
2226 MAX_DEPTH
, i
->keep_first_level
);
2229 static int clean_item(Item
*i
) {
2232 log_debug("Running clean action for entry %c %s", (char) i
->type
, i
->path
);
2235 case CREATE_DIRECTORY
:
2236 case CREATE_SUBVOLUME
:
2237 case CREATE_SUBVOLUME_INHERIT_QUOTA
:
2238 case CREATE_SUBVOLUME_NEW_QUOTA
:
2239 case TRUNCATE_DIRECTORY
:
2242 clean_item_instance(i
, i
->path
);
2244 case EMPTY_DIRECTORY
:
2245 case IGNORE_DIRECTORY_PATH
:
2246 return glob_item(i
, clean_item_instance
);
2252 static int process_item(Item
*i
, OperationMask operation
) {
2258 todo
= operation
& ~i
->done
;
2259 if (todo
== 0) /* Everything already done? */
2262 i
->done
|= operation
;
2264 r
= chase_symlinks(i
->path
, arg_root
, CHASE_NO_AUTOFS
|CHASE_WARN
, NULL
, NULL
);
2265 if (r
== -EREMOTE
) {
2266 log_notice_errno(r
, "Skipping %s", i
->path
);
2270 log_debug_errno(r
, "Failed to determine whether '%s' is below autofs, ignoring: %m", i
->path
);
2272 r
= FLAGS_SET(operation
, OPERATION_CREATE
) ? create_item(i
) : 0;
2273 /* Failure can only be tolerated for create */
2274 if (i
->allow_failure
)
2277 q
= FLAGS_SET(operation
, OPERATION_REMOVE
) ? remove_item(i
) : 0;
2278 p
= FLAGS_SET(operation
, OPERATION_CLEAN
) ? clean_item(i
) : 0;
2285 static int process_item_array(ItemArray
*array
, OperationMask operation
) {
2291 /* Create any parent first. */
2292 if (FLAGS_SET(operation
, OPERATION_CREATE
) && array
->parent
)
2293 r
= process_item_array(array
->parent
, operation
& OPERATION_CREATE
);
2295 /* Clean up all children first */
2296 if ((operation
& (OPERATION_REMOVE
|OPERATION_CLEAN
)) && !set_isempty(array
->children
)) {
2300 SET_FOREACH(c
, array
->children
, i
) {
2303 k
= process_item_array(c
, operation
& (OPERATION_REMOVE
|OPERATION_CLEAN
));
2304 if (k
< 0 && r
== 0)
2309 for (n
= 0; n
< array
->n_items
; n
++) {
2312 k
= process_item(array
->items
+ n
, operation
);
2313 if (k
< 0 && r
== 0)
2320 static void item_free_contents(Item
*i
) {
2324 strv_free(i
->xattrs
);
2327 acl_free(i
->acl_access
);
2328 acl_free(i
->acl_default
);
2332 static ItemArray
* item_array_free(ItemArray
*a
) {
2338 for (n
= 0; n
< a
->n_items
; n
++)
2339 item_free_contents(a
->items
+ n
);
2341 set_free(a
->children
);
2346 static int item_compare(const Item
*a
, const Item
*b
) {
2347 /* Make sure that the ownership taking item is put first, so
2348 * that we first create the node, and then can adjust it */
2350 if (takes_ownership(a
->type
) && !takes_ownership(b
->type
))
2352 if (!takes_ownership(a
->type
) && takes_ownership(b
->type
))
2355 return CMP(a
->type
, b
->type
);
2358 static bool item_compatible(Item
*a
, Item
*b
) {
2361 assert(streq(a
->path
, b
->path
));
2363 if (takes_ownership(a
->type
) && takes_ownership(b
->type
))
2364 /* check if the items are the same */
2365 return streq_ptr(a
->argument
, b
->argument
) &&
2367 a
->uid_set
== b
->uid_set
&&
2370 a
->gid_set
== b
->gid_set
&&
2373 a
->mode_set
== b
->mode_set
&&
2374 a
->mode
== b
->mode
&&
2376 a
->age_set
== b
->age_set
&&
2379 a
->mask_perms
== b
->mask_perms
&&
2381 a
->keep_first_level
== b
->keep_first_level
&&
2383 a
->major_minor
== b
->major_minor
;
2388 static bool should_include_path(const char *path
) {
2391 STRV_FOREACH(prefix
, arg_exclude_prefixes
)
2392 if (path_startswith(path
, *prefix
)) {
2393 log_debug("Entry \"%s\" matches exclude prefix \"%s\", skipping.",
2398 STRV_FOREACH(prefix
, arg_include_prefixes
)
2399 if (path_startswith(path
, *prefix
)) {
2400 log_debug("Entry \"%s\" matches include prefix \"%s\".", path
, *prefix
);
2404 /* no matches, so we should include this path only if we
2405 * have no whitelist at all */
2406 if (strv_isempty(arg_include_prefixes
))
2409 log_debug("Entry \"%s\" does not match any include prefix, skipping.", path
);
2413 static int specifier_expansion_from_arg(Item
*i
) {
2414 _cleanup_free_
char *unescaped
= NULL
, *resolved
= NULL
;
2425 case CREATE_SYMLINK
:
2429 r
= cunescape(i
->argument
, 0, &unescaped
);
2431 return log_error_errno(r
, "Failed to unescape parameter to write: %s", i
->argument
);
2433 r
= specifier_printf(unescaped
, specifier_table
, NULL
, &resolved
);
2437 free_and_replace(i
->argument
, resolved
);
2441 case RECURSIVE_SET_XATTR
:
2442 STRV_FOREACH(xattr
, i
->xattrs
) {
2443 r
= specifier_printf(*xattr
, specifier_table
, NULL
, &resolved
);
2447 free_and_replace(*xattr
, resolved
);
2457 static int patch_var_run(const char *fname
, unsigned line
, char **path
) {
2464 /* Optionally rewrites lines referencing /var/run/, to use /run/ instead. Why bother? tmpfiles merges lines in
2465 * some cases and detects conflicts in others. If files/directories are specified through two equivalent lines
2466 * this is problematic as neither case will be detected. Ideally we'd detect these cases by resolving symlinks
2467 * early, but that's precisely not what we can do here as this code very likely is running very early on, at a
2468 * time where the paths in question are not available yet, or even more importantly, our own tmpfiles rules
2469 * might create the paths that are intermediary to the listed paths. We can't really cover the generic case,
2470 * but the least we can do is cover the specific case of /var/run vs. /run, as /var/run is a legacy name for
2471 * /run only, and we explicitly document that and require that on systemd systems the former is a symlink to
2472 * the latter. Moreover files below this path are by far the primary usecase for tmpfiles.d/. */
2474 k
= path_startswith(*path
, "/var/run/");
2475 if (isempty(k
)) /* Don't complain about other paths than /var/run, and not about /var/run itself either. */
2478 n
= path_join("/run", k
);
2482 /* Also log about this briefly. We do so at LOG_NOTICE level, as we fixed up the situation automatically, hence
2483 * there's no immediate need for action by the user. However, in the interest of making things less confusing
2484 * to the user, let's still inform the user that these snippets should really be updated. */
2485 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
);
2487 free_and_replace(*path
, n
);
2492 static int find_uid(const char *user
, uid_t
*ret_uid
, Hashmap
**cache
) {
2498 /* First: parse as numeric UID string */
2499 r
= parse_uid(user
, ret_uid
);
2503 /* Second: pass to NSS if we are running "online" */
2505 return get_user_creds(&user
, ret_uid
, NULL
, NULL
, NULL
, 0);
2507 /* Third, synthesize "root" unconditionally */
2508 if (streq(user
, "root")) {
2513 /* Fourth: use fgetpwent() to read /etc/passwd directly, if we are "offline" */
2514 return name_to_uid_offline(arg_root
, user
, ret_uid
, cache
);
2517 static int find_gid(const char *group
, gid_t
*ret_gid
, Hashmap
**cache
) {
2523 /* First: parse as numeric GID string */
2524 r
= parse_gid(group
, ret_gid
);
2528 /* Second: pass to NSS if we are running "online" */
2530 return get_group_creds(&group
, ret_gid
, 0);
2532 /* Third, synthesize "root" unconditionally */
2533 if (streq(group
, "root")) {
2538 /* Fourth: use fgetgrent() to read /etc/group directly, if we are "offline" */
2539 return name_to_gid_offline(arg_root
, group
, ret_gid
, cache
);
2542 static int parse_line(
2546 bool *invalid_config
,
2547 Hashmap
**uid_cache
,
2548 Hashmap
**gid_cache
) {
2550 _cleanup_free_
char *action
= NULL
, *mode
= NULL
, *user
= NULL
, *group
= NULL
, *age
= NULL
, *path
= NULL
;
2551 _cleanup_(item_free_contents
) Item i
= {};
2552 ItemArray
*existing
;
2555 bool append_or_force
= false, boot
= false, allow_failure
= false;
2561 r
= extract_many_words(
2573 if (IN_SET(r
, -EINVAL
, -EBADSLT
))
2574 /* invalid quoting and such or an unknown specifier */
2575 *invalid_config
= true;
2576 return log_syntax(NULL
, LOG_ERR
, fname
, line
, r
, "Failed to parse line: %m");
2578 *invalid_config
= true;
2579 return log_syntax(NULL
, LOG_ERR
, fname
, line
, SYNTHETIC_ERRNO(EBADMSG
), "Syntax error.");
2582 if (!empty_or_dash(buffer
)) {
2583 i
.argument
= strdup(buffer
);
2588 if (isempty(action
)) {
2589 *invalid_config
= true;
2590 return log_syntax(NULL
, LOG_ERR
, fname
, line
, SYNTHETIC_ERRNO(EBADMSG
), "Command too short '%s'.", action
);
2593 for (pos
= 1; action
[pos
]; pos
++) {
2594 if (action
[pos
] == '!' && !boot
)
2596 else if (action
[pos
] == '+' && !append_or_force
)
2597 append_or_force
= true;
2598 else if (action
[pos
] == '-' && !allow_failure
)
2599 allow_failure
= true;
2601 *invalid_config
= true;
2602 return log_syntax(NULL
, LOG_ERR
, fname
, line
, SYNTHETIC_ERRNO(EBADMSG
), "Unknown modifiers in command '%s'", action
);
2606 if (boot
&& !arg_boot
) {
2607 log_syntax(NULL
, LOG_DEBUG
, fname
, line
, 0, "Ignoring entry %s \"%s\" because --boot is not specified.", action
, path
);
2612 i
.append_or_force
= append_or_force
;
2613 i
.allow_failure
= allow_failure
;
2615 r
= specifier_printf(path
, specifier_table
, NULL
, &i
.path
);
2617 return log_unresolvable_specifier(fname
, line
);
2619 if (IN_SET(r
, -EINVAL
, -EBADSLT
))
2620 *invalid_config
= true;
2621 return log_syntax(NULL
, LOG_ERR
, fname
, line
, r
, "Failed to replace specifiers in '%s': %m", path
);
2624 r
= patch_var_run(fname
, line
, &i
.path
);
2630 case CREATE_DIRECTORY
:
2631 case CREATE_SUBVOLUME
:
2632 case CREATE_SUBVOLUME_INHERIT_QUOTA
:
2633 case CREATE_SUBVOLUME_NEW_QUOTA
:
2634 case EMPTY_DIRECTORY
:
2635 case TRUNCATE_DIRECTORY
:
2638 case IGNORE_DIRECTORY_PATH
:
2640 case RECURSIVE_REMOVE_PATH
:
2643 case RECURSIVE_RELABEL_PATH
:
2645 log_syntax(NULL
, LOG_WARNING
, fname
, line
, 0, "%c lines don't take argument fields, ignoring.", i
.type
);
2653 case CREATE_SYMLINK
:
2655 i
.argument
= path_join("/usr/share/factory", i
.path
);
2663 *invalid_config
= true;
2664 return log_syntax(NULL
, LOG_ERR
, fname
, line
, SYNTHETIC_ERRNO(EBADMSG
), "Write file requires argument.");
2670 i
.argument
= path_join("/usr/share/factory", i
.path
);
2674 } else if (!path_is_absolute(i
.argument
)) {
2675 *invalid_config
= true;
2676 return log_syntax(NULL
, LOG_ERR
, fname
, line
, SYNTHETIC_ERRNO(EBADMSG
), "Source path '%s' is not absolute.", i
.argument
);
2680 if (!empty_or_root(arg_root
)) {
2683 p
= path_join(arg_root
, i
.argument
);
2686 free_and_replace(i
.argument
, p
);
2689 path_simplify(i
.argument
, false);
2692 case CREATE_CHAR_DEVICE
:
2693 case CREATE_BLOCK_DEVICE
:
2695 *invalid_config
= true;
2696 return log_syntax(NULL
, LOG_ERR
, fname
, line
, SYNTHETIC_ERRNO(EBADMSG
), "Device file requires argument.");
2699 r
= parse_dev(i
.argument
, &i
.major_minor
);
2701 *invalid_config
= true;
2702 return log_syntax(NULL
, LOG_ERR
, fname
, line
, r
, "Can't parse device file major/minor '%s'.", i
.argument
);
2708 case RECURSIVE_SET_XATTR
:
2710 *invalid_config
= true;
2711 return log_syntax(NULL
, LOG_ERR
, fname
, line
, SYNTHETIC_ERRNO(EBADMSG
),
2712 "Set extended attribute requires argument.");
2714 r
= parse_xattrs_from_arg(&i
);
2720 case RECURSIVE_SET_ACL
:
2722 *invalid_config
= true;
2723 return log_syntax(NULL
, LOG_ERR
, fname
, line
, SYNTHETIC_ERRNO(EBADMSG
),
2724 "Set ACLs requires argument.");
2726 r
= parse_acls_from_arg(&i
);
2732 case RECURSIVE_SET_ATTRIBUTE
:
2734 *invalid_config
= true;
2735 return log_syntax(NULL
, LOG_ERR
, fname
, line
, SYNTHETIC_ERRNO(EBADMSG
),
2736 "Set file attribute requires argument.");
2738 r
= parse_attribute_from_arg(&i
);
2739 if (IN_SET(r
, -EINVAL
, -EBADSLT
))
2740 *invalid_config
= true;
2746 *invalid_config
= true;
2747 return log_syntax(NULL
, LOG_ERR
, fname
, line
, SYNTHETIC_ERRNO(EBADMSG
),
2748 "Unknown command type '%c'.", (char) i
.type
);
2751 if (!path_is_absolute(i
.path
)) {
2752 *invalid_config
= true;
2753 return log_syntax(NULL
, LOG_ERR
, fname
, line
, SYNTHETIC_ERRNO(EBADMSG
),
2754 "Path '%s' not absolute.", i
.path
);
2757 path_simplify(i
.path
, false);
2759 if (!should_include_path(i
.path
))
2762 r
= specifier_expansion_from_arg(&i
);
2764 return log_unresolvable_specifier(fname
, line
);
2766 if (IN_SET(r
, -EINVAL
, -EBADSLT
))
2767 *invalid_config
= true;
2768 return log_syntax(NULL
, LOG_ERR
, fname
, line
, r
, "Failed to substitute specifiers in argument: %m");
2771 if (!empty_or_root(arg_root
)) {
2774 p
= path_join(arg_root
, i
.path
);
2777 free_and_replace(i
.path
, p
);
2780 if (!empty_or_dash(user
)) {
2781 r
= find_uid(user
, &i
.uid
, uid_cache
);
2783 *invalid_config
= true;
2784 return log_syntax(NULL
, LOG_ERR
, fname
, line
, r
, "Failed to resolve user '%s': %m", user
);
2790 if (!empty_or_dash(group
)) {
2791 r
= find_gid(group
, &i
.gid
, gid_cache
);
2793 *invalid_config
= true;
2794 return log_syntax(NULL
, LOG_ERR
, fname
, line
, r
, "Failed to resolve group '%s'.", group
);
2800 if (!empty_or_dash(mode
)) {
2801 const char *mm
= mode
;
2805 i
.mask_perms
= true;
2809 r
= parse_mode(mm
, &m
);
2811 *invalid_config
= true;
2812 return log_syntax(NULL
, LOG_ERR
, fname
, line
, r
, "Invalid mode '%s'.", mode
);
2818 i
.mode
= IN_SET(i
.type
, CREATE_DIRECTORY
, TRUNCATE_DIRECTORY
, CREATE_SUBVOLUME
, CREATE_SUBVOLUME_INHERIT_QUOTA
, CREATE_SUBVOLUME_NEW_QUOTA
) ? 0755 : 0644;
2820 if (!empty_or_dash(age
)) {
2821 const char *a
= age
;
2824 i
.keep_first_level
= true;
2828 r
= parse_sec(a
, &i
.age
);
2830 *invalid_config
= true;
2831 return log_syntax(NULL
, LOG_ERR
, fname
, line
, r
, "Invalid age '%s'.", age
);
2837 h
= needs_glob(i
.type
) ? globs
: items
;
2839 existing
= ordered_hashmap_get(h
, i
.path
);
2843 for (n
= 0; n
< existing
->n_items
; n
++) {
2844 if (!item_compatible(existing
->items
+ n
, &i
) && !i
.append_or_force
) {
2845 log_syntax(NULL
, LOG_NOTICE
, fname
, line
, 0, "Duplicate line for path \"%s\", ignoring.", i
.path
);
2850 existing
= new0(ItemArray
, 1);
2854 r
= ordered_hashmap_put(h
, i
.path
, existing
);
2861 if (!GREEDY_REALLOC(existing
->items
, existing
->allocated
, existing
->n_items
+ 1))
2864 existing
->items
[existing
->n_items
++] = i
;
2865 i
= (struct Item
) {};
2867 /* Sort item array, to enforce stable ordering of application */
2868 typesafe_qsort(existing
->items
, existing
->n_items
, item_compare
);
2873 static int cat_config(char **config_dirs
, char **args
) {
2874 _cleanup_strv_free_
char **files
= NULL
;
2877 r
= conf_files_list_with_replacement(arg_root
, config_dirs
, arg_replace
, &files
, NULL
);
2881 return cat_files(NULL
, files
, 0);
2884 static int help(void) {
2885 _cleanup_free_
char *link
= NULL
;
2888 r
= terminal_urlify_man("systemd-tmpfiles", "8", &link
);
2892 printf("%s [OPTIONS...] [CONFIGURATION FILE...]\n\n"
2893 "Creates, deletes and cleans up volatile and temporary files and directories.\n\n"
2894 " -h --help Show this help\n"
2895 " --user Execute user configuration\n"
2896 " --version Show package version\n"
2897 " --cat-config Show configuration files\n"
2898 " --create Create marked files/directories\n"
2899 " --clean Clean up marked directories\n"
2900 " --remove Remove marked files/directories\n"
2901 " --boot Execute actions only safe at boot\n"
2902 " --prefix=PATH Only apply rules with the specified prefix\n"
2903 " --exclude-prefix=PATH Ignore rules with the specified prefix\n"
2904 " --root=PATH Operate on an alternate filesystem root\n"
2905 " --replace=PATH Treat arguments as replacement for PATH\n"
2906 " --no-pager Do not pipe output into a pager\n"
2907 "\nSee the %s for details.\n"
2908 , program_invocation_short_name
2915 static int parse_argv(int argc
, char *argv
[]) {
2918 ARG_VERSION
= 0x100,
2932 static const struct option options
[] = {
2933 { "help", no_argument
, NULL
, 'h' },
2934 { "user", no_argument
, NULL
, ARG_USER
},
2935 { "version", no_argument
, NULL
, ARG_VERSION
},
2936 { "cat-config", no_argument
, NULL
, ARG_CAT_CONFIG
},
2937 { "create", no_argument
, NULL
, ARG_CREATE
},
2938 { "clean", no_argument
, NULL
, ARG_CLEAN
},
2939 { "remove", no_argument
, NULL
, ARG_REMOVE
},
2940 { "boot", no_argument
, NULL
, ARG_BOOT
},
2941 { "prefix", required_argument
, NULL
, ARG_PREFIX
},
2942 { "exclude-prefix", required_argument
, NULL
, ARG_EXCLUDE_PREFIX
},
2943 { "root", required_argument
, NULL
, ARG_ROOT
},
2944 { "replace", required_argument
, NULL
, ARG_REPLACE
},
2945 { "no-pager", no_argument
, NULL
, ARG_NO_PAGER
},
2954 while ((c
= getopt_long(argc
, argv
, "h", options
, NULL
)) >= 0)
2964 case ARG_CAT_CONFIG
:
2965 arg_cat_config
= true;
2973 arg_operation
|= OPERATION_CREATE
;
2977 arg_operation
|= OPERATION_CLEAN
;
2981 arg_operation
|= OPERATION_REMOVE
;
2989 if (strv_push(&arg_include_prefixes
, optarg
) < 0)
2993 case ARG_EXCLUDE_PREFIX
:
2994 if (strv_push(&arg_exclude_prefixes
, optarg
) < 0)
2999 r
= parse_path_argument_and_warn(optarg
, /* suppress_root= */ false, &arg_root
);
3005 if (!path_is_absolute(optarg
) ||
3006 !endswith(optarg
, ".conf"))
3007 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
3008 "The argument to --replace= must an absolute path to a config file");
3010 arg_replace
= optarg
;
3014 arg_pager_flags
|= PAGER_DISABLE
;
3021 assert_not_reached("Unhandled option");
3024 if (arg_operation
== 0 && !arg_cat_config
)
3025 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
3026 "You need to specify at least one of --clean, --create or --remove.");
3028 if (arg_replace
&& arg_cat_config
)
3029 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
3030 "Option --replace= is not supported with --cat-config");
3032 if (arg_replace
&& optind
>= argc
)
3033 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
),
3034 "When --replace= is given, some configuration items must be specified");
3039 static int read_config_file(char **config_dirs
, const char *fn
, bool ignore_enoent
, bool *invalid_config
) {
3040 _cleanup_(hashmap_freep
) Hashmap
*uid_cache
= NULL
, *gid_cache
= NULL
;
3041 _cleanup_fclose_
FILE *_f
= NULL
;
3050 if (streq(fn
, "-")) {
3051 log_debug("Reading config from stdin…");
3055 r
= search_and_fopen(fn
, "re", arg_root
, (const char**) config_dirs
, &_f
);
3057 if (ignore_enoent
&& r
== -ENOENT
) {
3058 log_debug_errno(r
, "Failed to open \"%s\", ignoring: %m", fn
);
3062 return log_error_errno(r
, "Failed to open '%s': %m", fn
);
3064 log_debug("Reading config file \"%s\"…", fn
);
3069 _cleanup_free_
char *line
= NULL
;
3070 bool invalid_line
= false;
3074 k
= read_line(f
, LONG_LINE_MAX
, &line
);
3076 return log_error_errno(k
, "Failed to read '%s': %m", fn
);
3083 if (IN_SET(*l
, 0, '#'))
3086 k
= parse_line(fn
, v
, l
, &invalid_line
, &uid_cache
, &gid_cache
);
3089 /* Allow reporting with a special code if the caller requested this */
3090 *invalid_config
= true;
3092 /* The first error becomes our return value */
3097 /* we have to determine age parameter for each entry of type X */
3098 ORDERED_HASHMAP_FOREACH(i
, globs
, iterator
) {
3100 Item
*j
, *candidate_item
= NULL
;
3102 if (i
->type
!= IGNORE_DIRECTORY_PATH
)
3105 ORDERED_HASHMAP_FOREACH(j
, items
, iter
) {
3106 if (!IN_SET(j
->type
, CREATE_DIRECTORY
, TRUNCATE_DIRECTORY
, CREATE_SUBVOLUME
, CREATE_SUBVOLUME_INHERIT_QUOTA
, CREATE_SUBVOLUME_NEW_QUOTA
))
3109 if (path_equal(j
->path
, i
->path
)) {
3114 if ((!candidate_item
&& path_startswith(i
->path
, j
->path
)) ||
3115 (candidate_item
&& path_startswith(j
->path
, candidate_item
->path
) && (fnmatch(i
->path
, j
->path
, FNM_PATHNAME
| FNM_PERIOD
) == 0)))
3119 if (candidate_item
&& candidate_item
->age_set
) {
3120 i
->age
= candidate_item
->age
;
3126 log_error_errno(errno
, "Failed to read from file %s: %m", fn
);
3134 static int parse_arguments(char **config_dirs
, char **args
, bool *invalid_config
) {
3138 STRV_FOREACH(arg
, args
) {
3139 r
= read_config_file(config_dirs
, *arg
, false, invalid_config
);
3147 static int read_config_files(char **config_dirs
, char **args
, bool *invalid_config
) {
3148 _cleanup_strv_free_
char **files
= NULL
;
3149 _cleanup_free_
char *p
= NULL
;
3153 r
= conf_files_list_with_replacement(arg_root
, config_dirs
, arg_replace
, &files
, &p
);
3157 STRV_FOREACH(f
, files
)
3158 if (p
&& path_equal(*f
, p
)) {
3159 log_debug("Parsing arguments at position \"%s\"…", *f
);
3161 r
= parse_arguments(config_dirs
, args
, invalid_config
);
3165 /* Just warn, ignore result otherwise.
3166 * read_config_file() has some debug output, so no need to print anything. */
3167 (void) read_config_file(config_dirs
, *f
, true, invalid_config
);
3172 static int link_parent(ItemArray
*a
) {
3179 /* Finds the closest "parent" item array for the specified item array. Then registers the specified item array
3180 * as child of it, and fills the parent in, linking them both ways. This allows us to later create parents
3181 * before their children, and clean up/remove children before their parents. */
3183 if (a
->n_items
<= 0)
3186 path
= a
->items
[0].path
;
3187 prefix
= newa(char, strlen(path
) + 1);
3188 PATH_FOREACH_PREFIX(prefix
, path
) {
3191 j
= ordered_hashmap_get(items
, prefix
);
3193 j
= ordered_hashmap_get(globs
, prefix
);
3195 r
= set_ensure_allocated(&j
->children
, NULL
);
3199 r
= set_put(j
->children
, a
);
3211 DEFINE_PRIVATE_HASH_OPS_WITH_VALUE_DESTRUCTOR(item_array_hash_ops
, char, string_hash_func
, string_compare_func
,
3212 ItemArray
, item_array_free
);
3214 static int run(int argc
, char *argv
[]) {
3215 _cleanup_strv_free_
char **config_dirs
= NULL
;
3216 bool invalid_config
= false;
3220 PHASE_REMOVE_AND_CLEAN
,
3226 r
= parse_argv(argc
, argv
);
3230 log_setup_service();
3232 /* Descending down file system trees might take a lot of fds */
3233 (void) rlimit_nofile_bump(HIGH_RLIMIT_NOFILE
);
3236 r
= user_config_paths(&config_dirs
);
3238 return log_error_errno(r
, "Failed to initialize configuration directory list: %m");
3240 config_dirs
= strv_split_nulstr(CONF_PATHS_NULSTR("tmpfiles.d"));
3245 if (DEBUG_LOGGING
) {
3246 _cleanup_free_
char *t
= NULL
;
3248 t
= strv_join(config_dirs
, "\n\t");
3250 log_debug("Looking for configuration files in (higher priority first):\n\t%s", t
);
3253 if (arg_cat_config
) {
3254 (void) pager_open(arg_pager_flags
);
3256 return cat_config(config_dirs
, argv
+ optind
);
3263 items
= ordered_hashmap_new(&item_array_hash_ops
);
3264 globs
= ordered_hashmap_new(&item_array_hash_ops
);
3265 if (!items
|| !globs
)
3268 /* If command line arguments are specified along with --replace, read all
3269 * configuration files and insert the positional arguments at the specified
3270 * place. Otherwise, if command line arguments are specified, execute just
3271 * them, and finally, without --replace= or any positional arguments, just
3272 * read configuration and execute it.
3274 if (arg_replace
|| optind
>= argc
)
3275 r
= read_config_files(config_dirs
, argv
+ optind
, &invalid_config
);
3277 r
= parse_arguments(config_dirs
, argv
+ optind
, &invalid_config
);
3281 /* Let's now link up all child/parent relationships */
3282 ORDERED_HASHMAP_FOREACH(a
, items
, iterator
) {
3287 ORDERED_HASHMAP_FOREACH(a
, globs
, iterator
) {
3293 /* If multiple operations are requested, let's first run the remove/clean operations, and only then the create
3294 * operations. i.e. that we first clean out the platform we then build on. */
3295 for (phase
= 0; phase
< _PHASE_MAX
; phase
++) {
3298 if (phase
== PHASE_REMOVE_AND_CLEAN
)
3299 op
= arg_operation
& (OPERATION_REMOVE
|OPERATION_CLEAN
);
3300 else if (phase
== PHASE_CREATE
)
3301 op
= arg_operation
& OPERATION_CREATE
;
3303 assert_not_reached("unexpected phase");
3305 if (op
== 0) /* Nothing requested in this phase */
3308 /* The non-globbing ones usually create things, hence we apply them first */
3309 ORDERED_HASHMAP_FOREACH(a
, items
, iterator
) {
3310 k
= process_item_array(a
, op
);
3311 if (k
< 0 && r
>= 0)
3315 /* The globbing ones usually alter things, hence we apply them second. */
3316 ORDERED_HASHMAP_FOREACH(a
, globs
, iterator
) {
3317 k
= process_item_array(a
, op
);
3318 if (k
< 0 && r
>= 0)
3323 if (ERRNO_IS_RESOURCE(-r
))
3328 return EX_CANTCREAT
;
3332 DEFINE_MAIN_FUNCTION_WITH_POSITIVE_FAILURE(run
);