chiark / gitweb /
tmpfiles: silently ignore any path that passes through autofs (#6506)
[elogind.git] / src / basic / fs-util.c
1 /***
2   This file is part of systemd.
3
4   Copyright 2010 Lennart Poettering
5
6   systemd is free software; you can redistribute it and/or modify it
7   under the terms of the GNU Lesser General Public License as published by
8   the Free Software Foundation; either version 2.1 of the License, or
9   (at your option) any later version.
10
11   systemd is distributed in the hope that it will be useful, but
12   WITHOUT ANY WARRANTY; without even the implied warranty of
13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14   Lesser General Public License for more details.
15
16   You should have received a copy of the GNU Lesser General Public License
17   along with systemd; If not, see <http://www.gnu.org/licenses/>.
18 ***/
19
20 #include <errno.h>
21 #include <stddef.h>
22 #include <stdio.h>
23 #include <stdlib.h>
24 #include <string.h>
25 #include <sys/stat.h>
26 #include <linux/magic.h>
27 #include <time.h>
28 #include <unistd.h>
29
30 #include "alloc-util.h"
31 #include "dirent-util.h"
32 #include "fd-util.h"
33 #include "fileio.h"
34 #include "fs-util.h"
35 //#include "log.h"
36 //#include "macro.h"
37 //#include "missing.h"
38 #include "mkdir.h"
39 #include "parse-util.h"
40 #include "path-util.h"
41 #include "process-util.h"
42 #include "stat-util.h"
43 #include "string-util.h"
44 #include "strv.h"
45 //#include "time-util.h"
46 #include "user-util.h"
47 #include "util.h"
48
49 int unlink_noerrno(const char *path) {
50         PROTECT_ERRNO;
51         int r;
52
53         r = unlink(path);
54         if (r < 0)
55                 return -errno;
56
57         return 0;
58 }
59
60 #if 0 /// UNNEEDED by elogind
61 int rmdir_parents(const char *path, const char *stop) {
62         size_t l;
63         int r = 0;
64
65         assert(path);
66         assert(stop);
67
68         l = strlen(path);
69
70         /* Skip trailing slashes */
71         while (l > 0 && path[l-1] == '/')
72                 l--;
73
74         while (l > 0) {
75                 char *t;
76
77                 /* Skip last component */
78                 while (l > 0 && path[l-1] != '/')
79                         l--;
80
81                 /* Skip trailing slashes */
82                 while (l > 0 && path[l-1] == '/')
83                         l--;
84
85                 if (l <= 0)
86                         break;
87
88                 t = strndup(path, l);
89                 if (!t)
90                         return -ENOMEM;
91
92                 if (path_startswith(stop, t)) {
93                         free(t);
94                         return 0;
95                 }
96
97                 r = rmdir(t);
98                 free(t);
99
100                 if (r < 0)
101                         if (errno != ENOENT)
102                                 return -errno;
103         }
104
105         return 0;
106 }
107
108
109 int rename_noreplace(int olddirfd, const char *oldpath, int newdirfd, const char *newpath) {
110         struct stat buf;
111         int ret;
112
113         ret = renameat2(olddirfd, oldpath, newdirfd, newpath, RENAME_NOREPLACE);
114         if (ret >= 0)
115                 return 0;
116
117         /* renameat2() exists since Linux 3.15, btrfs added support for it later.
118          * If it is not implemented, fallback to another method. */
119         if (!IN_SET(errno, EINVAL, ENOSYS))
120                 return -errno;
121
122         /* The link()/unlink() fallback does not work on directories. But
123          * renameat() without RENAME_NOREPLACE gives the same semantics on
124          * directories, except when newpath is an *empty* directory. This is
125          * good enough. */
126         ret = fstatat(olddirfd, oldpath, &buf, AT_SYMLINK_NOFOLLOW);
127         if (ret >= 0 && S_ISDIR(buf.st_mode)) {
128                 ret = renameat(olddirfd, oldpath, newdirfd, newpath);
129                 return ret >= 0 ? 0 : -errno;
130         }
131
132         /* If it is not a directory, use the link()/unlink() fallback. */
133         ret = linkat(olddirfd, oldpath, newdirfd, newpath, 0);
134         if (ret < 0)
135                 return -errno;
136
137         ret = unlinkat(olddirfd, oldpath, 0);
138         if (ret < 0) {
139                 /* backup errno before the following unlinkat() alters it */
140                 ret = errno;
141                 (void) unlinkat(newdirfd, newpath, 0);
142                 errno = ret;
143                 return -errno;
144         }
145
146         return 0;
147 }
148 #endif // 0
149
150 int readlinkat_malloc(int fd, const char *p, char **ret) {
151         size_t l = 100;
152         int r;
153
154         assert(p);
155         assert(ret);
156
157         for (;;) {
158                 char *c;
159                 ssize_t n;
160
161                 c = new(char, l);
162                 if (!c)
163                         return -ENOMEM;
164
165                 n = readlinkat(fd, p, c, l-1);
166                 if (n < 0) {
167                         r = -errno;
168                         free(c);
169                         return r;
170                 }
171
172                 if ((size_t) n < l-1) {
173                         c[n] = 0;
174                         *ret = c;
175                         return 0;
176                 }
177
178                 free(c);
179                 l *= 2;
180         }
181 }
182
183 int readlink_malloc(const char *p, char **ret) {
184         return readlinkat_malloc(AT_FDCWD, p, ret);
185 }
186
187 #if 0 /// UNNEEDED by elogind
188 int readlink_value(const char *p, char **ret) {
189         _cleanup_free_ char *link = NULL;
190         char *value;
191         int r;
192
193         r = readlink_malloc(p, &link);
194         if (r < 0)
195                 return r;
196
197         value = basename(link);
198         if (!value)
199                 return -ENOENT;
200
201         value = strdup(value);
202         if (!value)
203                 return -ENOMEM;
204
205         *ret = value;
206
207         return 0;
208 }
209 #endif // 0
210
211 int readlink_and_make_absolute(const char *p, char **r) {
212         _cleanup_free_ char *target = NULL;
213         char *k;
214         int j;
215
216         assert(p);
217         assert(r);
218
219         j = readlink_malloc(p, &target);
220         if (j < 0)
221                 return j;
222
223         k = file_in_same_dir(p, target);
224         if (!k)
225                 return -ENOMEM;
226
227         *r = k;
228         return 0;
229 }
230
231 #if 0 /// UNNEEDED by elogind
232 int readlink_and_canonicalize(const char *p, const char *root, char **ret) {
233         char *t, *s;
234         int r;
235
236         assert(p);
237         assert(ret);
238
239         r = readlink_and_make_absolute(p, &t);
240         if (r < 0)
241                 return r;
242
243         r = chase_symlinks(t, root, 0, &s);
244         if (r < 0)
245                 /* If we can't follow up, then let's return the original string, slightly cleaned up. */
246                 *ret = path_kill_slashes(t);
247         else {
248                 *ret = s;
249                 free(t);
250         }
251
252         return 0;
253 }
254
255 int readlink_and_make_absolute_root(const char *root, const char *path, char **ret) {
256         _cleanup_free_ char *target = NULL, *t = NULL;
257         const char *full;
258         int r;
259
260         full = prefix_roota(root, path);
261         r = readlink_malloc(full, &target);
262         if (r < 0)
263                 return r;
264
265         t = file_in_same_dir(path, target);
266         if (!t)
267                 return -ENOMEM;
268
269         *ret = t;
270         t = NULL;
271
272         return 0;
273 }
274 #endif // 0
275
276 int chmod_and_chown(const char *path, mode_t mode, uid_t uid, gid_t gid) {
277         assert(path);
278
279         /* Under the assumption that we are running privileged we
280          * first change the access mode and only then hand out
281          * ownership to avoid a window where access is too open. */
282
283         if (mode != MODE_INVALID)
284                 if (chmod(path, mode) < 0)
285                         return -errno;
286
287         if (uid != UID_INVALID || gid != GID_INVALID)
288                 if (chown(path, uid, gid) < 0)
289                         return -errno;
290
291         return 0;
292 }
293
294 int fchmod_umask(int fd, mode_t m) {
295         mode_t u;
296         int r;
297
298         u = umask(0777);
299         r = fchmod(fd, m & (~u)) < 0 ? -errno : 0;
300         umask(u);
301
302         return r;
303 }
304
305 int fd_warn_permissions(const char *path, int fd) {
306         struct stat st;
307
308         if (fstat(fd, &st) < 0)
309                 return -errno;
310
311         if (st.st_mode & 0111)
312                 log_warning("Configuration file %s is marked executable. Please remove executable permission bits. Proceeding anyway.", path);
313
314         if (st.st_mode & 0002)
315                 log_warning("Configuration file %s is marked world-writable. Please remove world writability permission bits. Proceeding anyway.", path);
316
317         if (getpid_cached() == 1 && (st.st_mode & 0044) != 0044)
318                 log_warning("Configuration file %s is marked world-inaccessible. This has no effect as configuration data is accessible via APIs without restrictions. Proceeding anyway.", path);
319
320         return 0;
321 }
322
323 int touch_file(const char *path, bool parents, usec_t stamp, uid_t uid, gid_t gid, mode_t mode) {
324         _cleanup_close_ int fd;
325         int r;
326
327         assert(path);
328
329         if (parents)
330                 mkdir_parents(path, 0755);
331
332         fd = open(path, O_WRONLY|O_CREAT|O_CLOEXEC|O_NOCTTY,
333                         (mode == 0 || mode == MODE_INVALID) ? 0644 : mode);
334         if (fd < 0)
335                 return -errno;
336
337         if (mode != MODE_INVALID) {
338                 r = fchmod(fd, mode);
339                 if (r < 0)
340                         return -errno;
341         }
342
343         if (uid != UID_INVALID || gid != GID_INVALID) {
344                 r = fchown(fd, uid, gid);
345                 if (r < 0)
346                         return -errno;
347         }
348
349         if (stamp != USEC_INFINITY) {
350                 struct timespec ts[2];
351
352                 timespec_store(&ts[0], stamp);
353                 ts[1] = ts[0];
354                 r = futimens(fd, ts);
355         } else
356                 r = futimens(fd, NULL);
357         if (r < 0)
358                 return -errno;
359
360         return 0;
361 }
362
363 int touch(const char *path) {
364         return touch_file(path, false, USEC_INFINITY, UID_INVALID, GID_INVALID, MODE_INVALID);
365 }
366
367 #if 0 /// UNNEEDED by elogind
368 int symlink_idempotent(const char *from, const char *to) {
369         _cleanup_free_ char *p = NULL;
370         int r;
371
372         assert(from);
373         assert(to);
374
375         if (symlink(from, to) < 0) {
376                 if (errno != EEXIST)
377                         return -errno;
378
379                 r = readlink_malloc(to, &p);
380                 if (r < 0)
381                         return r;
382
383                 if (!streq(p, from))
384                         return -EINVAL;
385         }
386
387         return 0;
388 }
389
390 int symlink_atomic(const char *from, const char *to) {
391         _cleanup_free_ char *t = NULL;
392         int r;
393
394         assert(from);
395         assert(to);
396
397         r = tempfn_random(to, NULL, &t);
398         if (r < 0)
399                 return r;
400
401         if (symlink(from, t) < 0)
402                 return -errno;
403
404         if (rename(t, to) < 0) {
405                 unlink_noerrno(t);
406                 return -errno;
407         }
408
409         return 0;
410 }
411
412 int mknod_atomic(const char *path, mode_t mode, dev_t dev) {
413         _cleanup_free_ char *t = NULL;
414         int r;
415
416         assert(path);
417
418         r = tempfn_random(path, NULL, &t);
419         if (r < 0)
420                 return r;
421
422         if (mknod(t, mode, dev) < 0)
423                 return -errno;
424
425         if (rename(t, path) < 0) {
426                 unlink_noerrno(t);
427                 return -errno;
428         }
429
430         return 0;
431 }
432
433 int mkfifo_atomic(const char *path, mode_t mode) {
434         _cleanup_free_ char *t = NULL;
435         int r;
436
437         assert(path);
438
439         r = tempfn_random(path, NULL, &t);
440         if (r < 0)
441                 return r;
442
443         if (mkfifo(t, mode) < 0)
444                 return -errno;
445
446         if (rename(t, path) < 0) {
447                 unlink_noerrno(t);
448                 return -errno;
449         }
450
451         return 0;
452 }
453 #endif // 0
454
455 int get_files_in_directory(const char *path, char ***list) {
456         _cleanup_closedir_ DIR *d = NULL;
457         struct dirent *de;
458         size_t bufsize = 0, n = 0;
459         _cleanup_strv_free_ char **l = NULL;
460
461         assert(path);
462
463         /* Returns all files in a directory in *list, and the number
464          * of files as return value. If list is NULL returns only the
465          * number. */
466
467         d = opendir(path);
468         if (!d)
469                 return -errno;
470
471         FOREACH_DIRENT_ALL(de, d, return -errno) {
472                 dirent_ensure_type(d, de);
473
474                 if (!dirent_is_file(de))
475                         continue;
476
477                 if (list) {
478                         /* one extra slot is needed for the terminating NULL */
479                         if (!GREEDY_REALLOC(l, bufsize, n + 2))
480                                 return -ENOMEM;
481
482                         l[n] = strdup(de->d_name);
483                         if (!l[n])
484                                 return -ENOMEM;
485
486                         l[++n] = NULL;
487                 } else
488                         n++;
489         }
490
491         if (list) {
492                 *list = l;
493                 l = NULL; /* avoid freeing */
494         }
495
496         return n;
497 }
498
499 static int getenv_tmp_dir(const char **ret_path) {
500         const char *n;
501         int r, ret = 0;
502
503         assert(ret_path);
504
505         /* We use the same order of environment variables python uses in tempfile.gettempdir():
506          * https://docs.python.org/3/library/tempfile.html#tempfile.gettempdir */
507         FOREACH_STRING(n, "TMPDIR", "TEMP", "TMP") {
508                 const char *e;
509
510                 e = secure_getenv(n);
511                 if (!e)
512                         continue;
513                 if (!path_is_absolute(e)) {
514                         r = -ENOTDIR;
515                         goto next;
516                 }
517                 if (!path_is_safe(e)) {
518                         r = -EPERM;
519                         goto next;
520                 }
521
522                 r = is_dir(e, true);
523                 if (r < 0)
524                         goto next;
525                 if (r == 0) {
526                         r = -ENOTDIR;
527                         goto next;
528                 }
529
530                 *ret_path = e;
531                 return 1;
532
533         next:
534                 /* Remember first error, to make this more debuggable */
535                 if (ret >= 0)
536                         ret = r;
537         }
538
539         if (ret < 0)
540                 return ret;
541
542         *ret_path = NULL;
543         return ret;
544 }
545
546 static int tmp_dir_internal(const char *def, const char **ret) {
547         const char *e;
548         int r, k;
549
550         assert(def);
551         assert(ret);
552
553         r = getenv_tmp_dir(&e);
554         if (r > 0) {
555                 *ret = e;
556                 return 0;
557         }
558
559         k = is_dir(def, true);
560         if (k == 0)
561                 k = -ENOTDIR;
562         if (k < 0)
563                 return r < 0 ? r : k;
564
565         *ret = def;
566         return 0;
567 }
568
569 #if 0 /// UNNEEDED by elogind
570 int var_tmp_dir(const char **ret) {
571
572         /* Returns the location for "larger" temporary files, that is backed by physical storage if available, and thus
573          * even might survive a boot: /var/tmp. If $TMPDIR (or related environment variables) are set, its value is
574          * returned preferably however. Note that both this function and tmp_dir() below are affected by $TMPDIR,
575          * making it a variable that overrides all temporary file storage locations. */
576
577         return tmp_dir_internal("/var/tmp", ret);
578 }
579 #endif // 0
580
581 int tmp_dir(const char **ret) {
582
583         /* Similar to var_tmp_dir() above, but returns the location for "smaller" temporary files, which is usually
584          * backed by an in-memory file system: /tmp. */
585
586         return tmp_dir_internal("/tmp", ret);
587 }
588
589 #if 0 /// UNNEEDED by elogind
590 int inotify_add_watch_fd(int fd, int what, uint32_t mask) {
591         char path[strlen("/proc/self/fd/") + DECIMAL_STR_MAX(int) + 1];
592         int r;
593
594         /* This is like inotify_add_watch(), except that the file to watch is not referenced by a path, but by an fd */
595         xsprintf(path, "/proc/self/fd/%i", what);
596
597         r = inotify_add_watch(fd, path, mask);
598         if (r < 0)
599                 return -errno;
600
601         return r;
602 }
603 #endif // 0
604
605 int chase_symlinks(const char *path, const char *original_root, unsigned flags, char **ret) {
606         _cleanup_free_ char *buffer = NULL, *done = NULL, *root = NULL;
607         _cleanup_close_ int fd = -1;
608         unsigned max_follow = 32; /* how many symlinks to follow before giving up and returning ELOOP */
609         bool exists = true;
610         char *todo;
611         int r;
612
613         assert(path);
614
615         /* This is a lot like canonicalize_file_name(), but takes an additional "root" parameter, that allows following
616          * symlinks relative to a root directory, instead of the root of the host.
617          *
618          * Note that "root" primarily matters if we encounter an absolute symlink. It is also used when following
619          * relative symlinks to ensure they cannot be used to "escape" the root directory. The path parameter passed is
620          * assumed to be already prefixed by it, except if the CHASE_PREFIX_ROOT flag is set, in which case it is first
621          * prefixed accordingly.
622          *
623          * Algorithmically this operates on two path buffers: "done" are the components of the path we already
624          * processed and resolved symlinks, "." and ".." of. "todo" are the components of the path we still need to
625          * process. On each iteration, we move one component from "todo" to "done", processing it's special meaning
626          * each time. The "todo" path always starts with at least one slash, the "done" path always ends in no
627          * slash. We always keep an O_PATH fd to the component we are currently processing, thus keeping lookup races
628          * at a minimum.
629          *
630          * Suggested usage: whenever you want to canonicalize a path, use this function. Pass the absolute path you got
631          * as-is: fully qualified and relative to your host's root. Optionally, specify the root parameter to tell this
632          * function what to do when encountering a symlink with an absolute path as directory: prefix it by the
633          * specified path.
634          *
635          * Note: there's also chase_symlinks_prefix() (see below), which as first step prefixes the passed path by the
636          * passed root. */
637
638         if (original_root) {
639                 r = path_make_absolute_cwd(original_root, &root);
640                 if (r < 0)
641                         return r;
642
643                 if (flags & CHASE_PREFIX_ROOT)
644                         path = prefix_roota(root, path);
645         }
646
647         r = path_make_absolute_cwd(path, &buffer);
648         if (r < 0)
649                 return r;
650
651         fd = open("/", O_CLOEXEC|O_NOFOLLOW|O_PATH);
652         if (fd < 0)
653                 return -errno;
654
655         todo = buffer;
656         for (;;) {
657                 _cleanup_free_ char *first = NULL;
658                 _cleanup_close_ int child = -1;
659                 struct stat st;
660                 size_t n, m;
661
662                 /* Determine length of first component in the path */
663                 n = strspn(todo, "/");                  /* The slashes */
664                 m = n + strcspn(todo + n, "/");         /* The entire length of the component */
665
666                 /* Extract the first component. */
667                 first = strndup(todo, m);
668                 if (!first)
669                         return -ENOMEM;
670
671                 todo += m;
672
673                 /* Just a single slash? Then we reached the end. */
674                 if (isempty(first) || path_equal(first, "/"))
675                         break;
676
677                 /* Just a dot? Then let's eat this up. */
678                 if (path_equal(first, "/."))
679                         continue;
680
681                 /* Two dots? Then chop off the last bit of what we already found out. */
682                 if (path_equal(first, "/..")) {
683                         _cleanup_free_ char *parent = NULL;
684                         int fd_parent = -1;
685
686                         /* If we already are at the top, then going up will not change anything. This is in-line with
687                          * how the kernel handles this. */
688                         if (isempty(done) || path_equal(done, "/"))
689                                 continue;
690
691                         parent = dirname_malloc(done);
692                         if (!parent)
693                                 return -ENOMEM;
694
695                         /* Don't allow this to leave the root dir.  */
696                         if (root &&
697                             path_startswith(done, root) &&
698                             !path_startswith(parent, root))
699                                 continue;
700
701                         free_and_replace(done, parent);
702
703                         fd_parent = openat(fd, "..", O_CLOEXEC|O_NOFOLLOW|O_PATH);
704                         if (fd_parent < 0)
705                                 return -errno;
706
707                         safe_close(fd);
708                         fd = fd_parent;
709
710                         continue;
711                 }
712
713                 /* Otherwise let's see what this is. */
714                 child = openat(fd, first + n, O_CLOEXEC|O_NOFOLLOW|O_PATH);
715                 if (child < 0) {
716
717                         if (errno == ENOENT &&
718                             (flags & CHASE_NONEXISTENT) &&
719                             (isempty(todo) || path_is_safe(todo))) {
720
721                                 /* If CHASE_NONEXISTENT is set, and the path does not exist, then that's OK, return
722                                  * what we got so far. But don't allow this if the remaining path contains "../ or "./"
723                                  * or something else weird. */
724
725                                 if (!strextend(&done, first, todo, NULL))
726                                         return -ENOMEM;
727
728                                 exists = false;
729                                 break;
730                         }
731
732                         return -errno;
733                 }
734
735                 if (fstat(child, &st) < 0)
736                         return -errno;
737                 if ((flags & CHASE_NO_AUTOFS) &&
738                     fd_check_fstype(child, AUTOFS_SUPER_MAGIC) > 0)
739                         return -EREMOTE;
740
741                 if (S_ISLNK(st.st_mode)) {
742                         char *joined;
743
744                         _cleanup_free_ char *destination = NULL;
745
746                         /* This is a symlink, in this case read the destination. But let's make sure we don't follow
747                          * symlinks without bounds. */
748                         if (--max_follow <= 0)
749                                 return -ELOOP;
750
751                         r = readlinkat_malloc(fd, first + n, &destination);
752                         if (r < 0)
753                                 return r;
754                         if (isempty(destination))
755                                 return -EINVAL;
756
757                         if (path_is_absolute(destination)) {
758
759                                 /* An absolute destination. Start the loop from the beginning, but use the root
760                                  * directory as base. */
761
762                                 safe_close(fd);
763                                 fd = open(root ?: "/", O_CLOEXEC|O_NOFOLLOW|O_PATH);
764                                 if (fd < 0)
765                                         return -errno;
766
767                                 free(done);
768
769                                 /* Note that we do not revalidate the root, we take it as is. */
770                                 if (isempty(root))
771                                         done = NULL;
772                                 else {
773                                         done = strdup(root);
774                                         if (!done)
775                                                 return -ENOMEM;
776                                 }
777
778                         }
779
780                         /* Prefix what's left to do with what we just read, and start the loop again,
781                          * but remain in the current directory. */
782
783                         joined = strjoin("/", destination, todo);
784                         if (!joined)
785                                 return -ENOMEM;
786
787                         free(buffer);
788                         todo = buffer = joined;
789
790                         continue;
791                 }
792
793                 /* If this is not a symlink, then let's just add the name we read to what we already verified. */
794                 if (!done) {
795                         done = first;
796                         first = NULL;
797                 } else {
798                         if (!strextend(&done, first, NULL))
799                                 return -ENOMEM;
800                 }
801
802                 /* And iterate again, but go one directory further down. */
803                 safe_close(fd);
804                 fd = child;
805                 child = -1;
806         }
807
808         if (!done) {
809                 /* Special case, turn the empty string into "/", to indicate the root directory. */
810                 done = strdup("/");
811                 if (!done)
812                         return -ENOMEM;
813         }
814
815         if (ret) {
816                 *ret = done;
817                 done = NULL;
818         }
819
820         return exists;
821 }