blob: a6b8f859aa948946fa025130ee2c1a0ce4381cf3 [file] [log] [blame]
/*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
/***
This file is part of systemd.
Copyright 2010 Lennart Poettering, Kay Sievers
systemd is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
systemd is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with systemd; If not, see <http://www.gnu.org/licenses/>.
***/
#include <unistd.h>
#include <fcntl.h>
#include <errno.h>
#include <string.h>
#include <sys/stat.h>
#include <limits.h>
#include <dirent.h>
#include <grp.h>
#include <pwd.h>
#include <stdio.h>
#include <stdlib.h>
#include <stddef.h>
#include <getopt.h>
#include <stdbool.h>
#include <time.h>
#include <sys/types.h>
#include <sys/param.h>
#include <glob.h>
#include <fnmatch.h>
#include "log.h"
#include "util.h"
#include "strv.h"
#include "label.h"
#include "set.h"
/* This reads all files listed in /etc/tmpfiles.d/?*.conf and creates
* them in the file system. This is intended to be used to create
* properly owned directories beneath /tmp, /var/tmp, /run, which are
* volatile and hence need to be recreated on bootup. */
enum {
/* These ones take file names */
CREATE_FILE = 'f',
TRUNCATE_FILE = 'F',
CREATE_DIRECTORY = 'd',
TRUNCATE_DIRECTORY = 'D',
CREATE_FIFO = 'p',
/* These ones take globs */
IGNORE_PATH = 'x',
REMOVE_PATH = 'r',
RECURSIVE_REMOVE_PATH = 'R'
};
typedef struct Item {
char type;
char *path;
uid_t uid;
gid_t gid;
mode_t mode;
usec_t age;
bool uid_set:1;
bool gid_set:1;
bool mode_set:1;
bool age_set:1;
} Item;
static Hashmap *items = NULL, *globs = NULL;
static Set *unix_sockets = NULL;
static bool arg_create = false;
static bool arg_clean = false;
static bool arg_remove = false;
static const char *arg_prefix = NULL;
#define MAX_DEPTH 256
static bool needs_glob(int t) {
return t == IGNORE_PATH || t == REMOVE_PATH || t == RECURSIVE_REMOVE_PATH;
}
static struct Item* find_glob(Hashmap *h, const char *match) {
Item *j;
Iterator i;
HASHMAP_FOREACH(j, h, i)
if (fnmatch(j->path, match, FNM_PATHNAME|FNM_PERIOD) == 0)
return j;
return NULL;
}
static void load_unix_sockets(void) {
FILE *f = NULL;
char line[LINE_MAX];
if (unix_sockets)
return;
/* We maintain a cache of the sockets we found in
* /proc/net/unix to speed things up a little. */
if (!(unix_sockets = set_new(string_hash_func, string_compare_func)))
return;
if (!(f = fopen("/proc/net/unix", "re")))
return;
if (!(fgets(line, sizeof(line), f)))
goto fail;
for (;;) {
char *p, *s;
int k;
if (!(fgets(line, sizeof(line), f)))
break;
truncate_nl(line);
if (strlen(line) < 53)
continue;
p = line + 53;
p += strspn(p, WHITESPACE);
p += strcspn(p, WHITESPACE);
p += strspn(p, WHITESPACE);
if (*p != '/')
continue;
if (!(s = strdup(p)))
goto fail;
path_kill_slashes(s);
if ((k = set_put(unix_sockets, s)) < 0) {
free(s);
if (k != -EEXIST)
goto fail;
}
}
return;
fail:
set_free_free(unix_sockets);
unix_sockets = NULL;
if (f)
fclose(f);
}
static bool unix_socket_alive(const char *fn) {
assert(fn);
load_unix_sockets();
if (unix_sockets)
return !!set_get(unix_sockets, (char*) fn);
/* We don't know, so assume yes */
return true;
}
static int dir_cleanup(
const char *p,
DIR *d,
const struct stat *ds,
usec_t cutoff,
dev_t rootdev,
bool mountpoint,
int maxdepth)
{
struct dirent *dent;
struct timespec times[2];
bool deleted = false;
char *sub_path = NULL;
int r = 0;
while ((dent = readdir(d))) {
struct stat s;
usec_t age;
if (streq(dent->d_name, ".") ||
streq(dent->d_name, ".."))
continue;
if (fstatat(dirfd(d), dent->d_name, &s, AT_SYMLINK_NOFOLLOW) < 0) {
if (errno != ENOENT) {
log_error("stat(%s/%s) failed: %m", p, dent->d_name);
r = -errno;
}
continue;
}
/* Stay on the same filesystem */
if (s.st_dev != rootdev)
continue;
/* Do not delete read-only files owned by root */
if (s.st_uid == 0 && !(s.st_mode & S_IWUSR))
continue;
free(sub_path);
sub_path = NULL;
if (asprintf(&sub_path, "%s/%s", p, dent->d_name) < 0) {
log_error("Out of memory");
r = -ENOMEM;
goto finish;
}
/* Is there an item configured for this path? */
if (hashmap_get(items, sub_path))
continue;
if (find_glob(globs, sub_path))
continue;
if (S_ISDIR(s.st_mode)) {
if (mountpoint &&
streq(dent->d_name, "lost+found") &&
s.st_uid == 0)
continue;
if (maxdepth <= 0)
log_warning("Reached max depth on %s.", sub_path);
else {
DIR *sub_dir;
int q;
sub_dir = xopendirat(dirfd(d), dent->d_name, O_NOFOLLOW);
if (sub_dir == NULL) {
if (errno != ENOENT) {
log_error("opendir(%s/%s) failed: %m", p, dent->d_name);
r = -errno;
}
continue;
}
q = dir_cleanup(sub_path, sub_dir, &s, cutoff, rootdev, false, maxdepth-1);
closedir(sub_dir);
if (q < 0)
r = q;
}
/* Ignore ctime, we change it when deleting */
age = MAX(timespec_load(&s.st_mtim),
timespec_load(&s.st_atim));
if (age >= cutoff)
continue;
log_debug("rmdir '%s'\n", sub_path);
if (unlinkat(dirfd(d), dent->d_name, AT_REMOVEDIR) < 0) {
if (errno != ENOENT && errno != ENOTEMPTY) {
log_error("rmdir(%s): %m", sub_path);
r = -errno;
}
}
} else {
/* Skip files for which the sticky bit is
* set. These are semantics we define, and are
* unknown elsewhere. See XDG_RUNTIME_DIR
* specification for details. */
if (s.st_mode & S_ISVTX)
continue;
if (mountpoint && S_ISREG(s.st_mode)) {
if (streq(dent->d_name, ".journal") &&
s.st_uid == 0)
continue;
if (streq(dent->d_name, "aquota.user") ||
streq(dent->d_name, "aquota.group"))
continue;
}
/* Ignore sockets that are listed in /proc/net/unix */
if (S_ISSOCK(s.st_mode) && unix_socket_alive(sub_path))
continue;
/* Ignore device nodes */
if (S_ISCHR(s.st_mode) || S_ISBLK(s.st_mode))
continue;
age = MAX3(timespec_load(&s.st_mtim),
timespec_load(&s.st_atim),
timespec_load(&s.st_ctim));
if (age >= cutoff)
continue;
log_debug("unlink '%s'\n", sub_path);
if (unlinkat(dirfd(d), dent->d_name, 0) < 0) {
if (errno != ENOENT) {
log_error("unlink(%s): %m", sub_path);
r = -errno;
}
}
deleted = true;
}
}
finish:
if (deleted) {
/* Restore original directory timestamps */
times[0] = ds->st_atim;
times[1] = ds->st_mtim;
if (futimens(dirfd(d), times) < 0)
log_error("utimensat(%s): %m", p);
}
free(sub_path);
return r;
}
static int clean_item(Item *i) {
DIR *d;
struct stat s, ps;
bool mountpoint;
int r;
usec_t cutoff, n;
assert(i);
if (i->type != CREATE_DIRECTORY &&
i->type != TRUNCATE_DIRECTORY &&
i->type != IGNORE_PATH)
return 0;
if (!i->age_set || i->age <= 0)
return 0;
n = now(CLOCK_REALTIME);
if (n < i->age)
return 0;
cutoff = n - i->age;
d = opendir(i->path);
if (!d) {
if (errno == ENOENT)
return 0;
log_error("Failed to open directory %s: %m", i->path);
return -errno;
}
if (fstat(dirfd(d), &s) < 0) {
log_error("stat(%s) failed: %m", i->path);
r = -errno;
goto finish;
}
if (!S_ISDIR(s.st_mode)) {
log_error("%s is not a directory.", i->path);
r = -ENOTDIR;
goto finish;
}
if (fstatat(dirfd(d), "..", &ps, AT_SYMLINK_NOFOLLOW) != 0) {
log_error("stat(%s/..) failed: %m", i->path);
r = -errno;
goto finish;
}
mountpoint = s.st_dev != ps.st_dev ||
(s.st_dev == ps.st_dev && s.st_ino == ps.st_ino);
r = dir_cleanup(i->path, d, &s, cutoff, s.st_dev, mountpoint, MAX_DEPTH);
finish:
if (d)
closedir(d);
return r;
}
static int create_item(Item *i) {
int fd = -1, r;
mode_t u;
struct stat st;
assert(i);
switch (i->type) {
case IGNORE_PATH:
case REMOVE_PATH:
case RECURSIVE_REMOVE_PATH:
return 0;
case CREATE_FILE:
case TRUNCATE_FILE:
u = umask(0);
fd = open(i->path, O_CREAT|O_NDELAY|O_CLOEXEC|O_WRONLY|O_NOCTTY|O_NOFOLLOW|
(i->type == TRUNCATE_FILE ? O_TRUNC : 0), i->mode);
umask(u);
if (fd < 0) {
log_error("Failed to create file %s: %m", i->path);
r = -errno;
goto finish;
}
if (fstat(fd, &st) < 0) {
log_error("stat(%s) failed: %m", i->path);
r = -errno;
goto finish;
}
if (!S_ISREG(st.st_mode)) {
log_error("%s is not a file.", i->path);
r = -EEXIST;
goto finish;
}
if (i->mode_set)
if (fchmod(fd, i->mode) < 0) {
log_error("chmod(%s) failed: %m", i->path);
r = -errno;
goto finish;
}
if (i->uid_set || i->gid_set)
if (fchown(fd,
i->uid_set ? i->uid : (uid_t) -1,
i->gid_set ? i->gid : (gid_t) -1) < 0) {
log_error("chown(%s) failed: %m", i->path);
r = -errno;
goto finish;
}
break;
case TRUNCATE_DIRECTORY:
case CREATE_DIRECTORY:
u = umask(0);
mkdir_parents(i->path, 0755);
r = mkdir(i->path, i->mode);
umask(u);
if (r < 0 && errno != EEXIST) {
log_error("Failed to create directory %s: %m", i->path);
r = -errno;
goto finish;
}
if (stat(i->path, &st) < 0) {
log_error("stat(%s) failed: %m", i->path);
r = -errno;
goto finish;
}
if (!S_ISDIR(st.st_mode)) {
log_error("%s is not a directory.", i->path);
r = -EEXIST;
goto finish;
}
if (i->mode_set)
if (chmod(i->path, i->mode) < 0) {
log_error("chmod(%s) failed: %m", i->path);
r = -errno;
goto finish;
}
if (i->uid_set || i->gid_set)
if (chown(i->path,
i->uid_set ? i->uid : (uid_t) -1,
i->gid_set ? i->gid : (gid_t) -1) < 0) {
log_error("chown(%s) failed: %m", i->path);
r = -errno;
goto finish;
}
break;
case CREATE_FIFO:
u = umask(0);
r = mkfifo(i->path, i->mode);
umask(u);
if (r < 0 && errno != EEXIST) {
log_error("Failed to create fifo %s: %m", i->path);
r = -errno;
goto finish;
}
if (stat(i->path, &st) < 0) {
log_error("stat(%s) failed: %m", i->path);
r = -errno;
goto finish;
}
if (!S_ISFIFO(st.st_mode)) {
log_error("%s is not a fifo.", i->path);
r = -EEXIST;
goto finish;
}
if (i->mode_set)
if (chmod(i->path, i->mode) < 0) {
log_error("chmod(%s) failed: %m", i->path);
r = -errno;
goto finish;
}
if (i->uid_set || i->gid_set)
if (chown(i->path,
i->uid_set ? i->uid : (uid_t) -1,
i->gid_set ? i->gid : (gid_t) -1) < 0) {
log_error("chown(%s) failed: %m", i->path);
r = -errno;
goto finish;
}
break;
}
if ((r = label_fix(i->path, false)) < 0)
goto finish;
log_debug("%s created successfully.", i->path);
finish:
if (fd >= 0)
close_nointr_nofail(fd);
return r;
}
static int remove_item(Item *i, const char *instance) {
int r;
assert(i);
switch (i->type) {
case CREATE_FILE:
case TRUNCATE_FILE:
case CREATE_DIRECTORY:
case CREATE_FIFO:
case IGNORE_PATH:
break;
case REMOVE_PATH:
if (remove(instance) < 0 && errno != ENOENT) {
log_error("remove(%s): %m", instance);
return -errno;
}
break;
case TRUNCATE_DIRECTORY:
case RECURSIVE_REMOVE_PATH:
if ((r = rm_rf(instance, false, i->type == RECURSIVE_REMOVE_PATH, false)) < 0 &&
r != -ENOENT) {
log_error("rm_rf(%s): %s", instance, strerror(-r));
return r;
}
break;
}
return 0;
}
static int remove_item_glob(Item *i) {
assert(i);
switch (i->type) {
case CREATE_FILE:
case TRUNCATE_FILE:
case CREATE_DIRECTORY:
case CREATE_FIFO:
case IGNORE_PATH:
break;
case REMOVE_PATH:
case TRUNCATE_DIRECTORY:
case RECURSIVE_REMOVE_PATH: {
int r = 0, k;
glob_t g;
char **fn;
zero(g);
errno = 0;
if ((k = glob(i->path, GLOB_NOSORT|GLOB_BRACE, NULL, &g)) != 0) {
if (k != GLOB_NOMATCH) {
if (errno != 0)
errno = EIO;
log_error("glob(%s) failed: %m", i->path);
return -errno;
}
}
STRV_FOREACH(fn, g.gl_pathv)
if ((k = remove_item(i, *fn)) < 0)
r = k;
globfree(&g);
return r;
}
}
return 0;
}
static int process_item(Item *i) {
int r, q, p;
assert(i);
r = arg_create ? create_item(i) : 0;
q = arg_remove ? remove_item_glob(i) : 0;
p = arg_clean ? clean_item(i) : 0;
if (r < 0)
return r;
if (q < 0)
return q;
return p;
}
static void item_free(Item *i) {
assert(i);
free(i->path);
free(i);
}
static bool item_equal(Item *a, Item *b) {
assert(a);
assert(b);
if (!streq_ptr(a->path, b->path))
return false;
if (a->type != b->type)
return false;
if (a->uid_set != b->uid_set ||
(a->uid_set && a->uid != b->uid))
return false;
if (a->gid_set != b->gid_set ||
(a->gid_set && a->gid != b->gid))
return false;
if (a->mode_set != b->mode_set ||
(a->mode_set && a->mode != b->mode))
return false;
if (a->age_set != b->age_set ||
(a->age_set && a->age != b->age))
return false;
return true;
}
static int parse_line(const char *fname, unsigned line, const char *buffer) {
Item *i, *existing;
char *mode = NULL, *user = NULL, *group = NULL, *age = NULL;
Hashmap *h;
int r;
assert(fname);
assert(line >= 1);
assert(buffer);
if (!(i = new0(Item, 1))) {
log_error("Out of memory");
return -ENOMEM;
}
if (sscanf(buffer,
"%c "
"%ms "
"%ms "
"%ms "
"%ms "
"%ms",
&i->type,
&i->path,
&mode,
&user,
&group,
&age) < 2) {
log_error("[%s:%u] Syntax error.", fname, line);
r = -EIO;
goto finish;
}
if (i->type != CREATE_FILE &&
i->type != TRUNCATE_FILE &&
i->type != CREATE_DIRECTORY &&
i->type != TRUNCATE_DIRECTORY &&
i->type != CREATE_FIFO &&
i->type != IGNORE_PATH &&
i->type != REMOVE_PATH &&
i->type != RECURSIVE_REMOVE_PATH) {
log_error("[%s:%u] Unknown file type '%c'.", fname, line, i->type);
r = -EBADMSG;
goto finish;
}
if (!path_is_absolute(i->path)) {
log_error("[%s:%u] Path '%s' not absolute.", fname, line, i->path);
r = -EBADMSG;
goto finish;
}
path_kill_slashes(i->path);
if (arg_prefix && !path_startswith(i->path, arg_prefix)) {
r = 0;
goto finish;
}
if (user && !streq(user, "-")) {
const char *u = user;
r = get_user_creds(&u, &i->uid, NULL, NULL);
if (r < 0) {
log_error("[%s:%u] Unknown user '%s'.", fname, line, user);
goto finish;
}
i->uid_set = true;
}
if (group && !streq(group, "-")) {
const char *g = group;
r = get_group_creds(&g, &i->gid);
if (r < 0) {
log_error("[%s:%u] Unknown group '%s'.", fname, line, group);
goto finish;
}
i->gid_set = true;
}
if (mode && !streq(mode, "-")) {
unsigned m;
if (sscanf(mode, "%o", &m) != 1) {
log_error("[%s:%u] Invalid mode '%s'.", fname, line, mode);
r = -ENOENT;
goto finish;
}
i->mode = m;
i->mode_set = true;
} else
i->mode = i->type == CREATE_DIRECTORY ? 0755 : 0644;
if (age && !streq(age, "-")) {
if (parse_usec(age, &i->age) < 0) {
log_error("[%s:%u] Invalid age '%s'.", fname, line, age);
r = -EBADMSG;
goto finish;
}
i->age_set = true;
}
h = needs_glob(i->type) ? globs : items;
if ((existing = hashmap_get(h, i->path))) {
/* Two identical items are fine */
if (!item_equal(existing, i))
log_warning("Two or more conflicting lines for %s configured, ignoring.", i->path);
r = 0;
goto finish;
}
if ((r = hashmap_put(h, i->path, i)) < 0) {
log_error("Failed to insert item %s: %s", i->path, strerror(-r));
goto finish;
}
i = NULL;
r = 0;
finish:
free(user);
free(group);
free(mode);
free(age);
if (i)
item_free(i);
return r;
}
static int help(void) {
printf("%s [OPTIONS...] [CONFIGURATION FILE...]\n\n"
"Creates, deletes and cleans up volatile and temporary files and directories.\n\n"
" -h --help Show this help\n"
" --create Create marked files/directories\n"
" --clean Clean up marked directories\n"
" --remove Remove marked files/directories\n"
" --prefix=PATH Only apply rules that apply to paths with the specified prefix\n",
program_invocation_short_name);
return 0;
}
static int parse_argv(int argc, char *argv[]) {
enum {
ARG_CREATE,
ARG_CLEAN,
ARG_REMOVE,
ARG_PREFIX
};
static const struct option options[] = {
{ "help", no_argument, NULL, 'h' },
{ "create", no_argument, NULL, ARG_CREATE },
{ "clean", no_argument, NULL, ARG_CLEAN },
{ "remove", no_argument, NULL, ARG_REMOVE },
{ "prefix", required_argument, NULL, ARG_PREFIX },
{ NULL, 0, NULL, 0 }
};
int c;
assert(argc >= 0);
assert(argv);
while ((c = getopt_long(argc, argv, "h", options, NULL)) >= 0) {
switch (c) {
case 'h':
help();
return 0;
case ARG_CREATE:
arg_create = true;
break;
case ARG_CLEAN:
arg_clean = true;
break;
case ARG_REMOVE:
arg_remove = true;
break;
case ARG_PREFIX:
arg_prefix = optarg;
break;
case '?':
return -EINVAL;
default:
log_error("Unknown option code %c", c);
return -EINVAL;
}
}
if (!arg_clean && !arg_create && !arg_remove) {
log_error("You need to specify at least one of --clean, --create or --remove.");
return -EINVAL;
}
return 1;
}
static int read_config_file(const char *fn, bool ignore_enoent) {
FILE *f;
unsigned v = 0;
int r = 0;
assert(fn);
if (!(f = fopen(fn, "re"))) {
if (ignore_enoent && errno == ENOENT)
return 0;
log_error("Failed to open %s: %m", fn);
return -errno;
}
log_debug("apply: %s\n", fn);
for (;;) {
char line[LINE_MAX], *l;
int k;
if (!(fgets(line, sizeof(line), f)))
break;
v++;
l = strstrip(line);
if (*l == '#' || *l == 0)
continue;
if ((k = parse_line(fn, v, l)) < 0)
if (r == 0)
r = k;
}
if (ferror(f)) {
log_error("Failed to read from file %s: %m", fn);
if (r == 0)
r = -EIO;
}
fclose(f);
return r;
}
int main(int argc, char *argv[]) {
int r;
Item *i;
Iterator iterator;
if ((r = parse_argv(argc, argv)) <= 0)
return r < 0 ? EXIT_FAILURE : EXIT_SUCCESS;
log_set_target(LOG_TARGET_AUTO);
log_parse_environment();
log_open();
umask(0022);
label_init();
items = hashmap_new(string_hash_func, string_compare_func);
globs = hashmap_new(string_hash_func, string_compare_func);
if (!items || !globs) {
log_error("Out of memory");
r = EXIT_FAILURE;
goto finish;
}
r = EXIT_SUCCESS;
if (optind < argc) {
int j;
for (j = optind; j < argc; j++)
if (read_config_file(argv[j], false) < 0)
r = EXIT_FAILURE;
} else {
char **files, **f;
r = conf_files_list(&files, ".conf",
"/run/tmpfiles.d",
"/etc/tmpfiles.d",
"/usr/local/lib/tmpfiles.d",
"/usr/lib/tmpfiles.d",
NULL);
if (r < 0) {
r = EXIT_FAILURE;
log_error("Failed to enumerate tmpfiles.d files: %s", strerror(-r));
goto finish;
}
STRV_FOREACH(f, files) {
if (read_config_file(*f, true) < 0)
r = EXIT_FAILURE;
}
strv_free(files);
}
HASHMAP_FOREACH(i, globs, iterator)
process_item(i);
HASHMAP_FOREACH(i, items, iterator)
process_item(i);
finish:
while ((i = hashmap_steal_first(items)))
item_free(i);
while ((i = hashmap_steal_first(globs)))
item_free(i);
hashmap_free(items);
hashmap_free(globs);
set_free_free(unix_sockets);
label_finish();
return r;
}