src/basic/fs-util.c

   1 /* SPDX-License-Identifier: LGPL-2.1+ */
   2 /***
   3   This file is part of systemd.
   4
   5   Copyright 2010 Lennart Poettering
   6 ***/
   7
   8 #include <errno.h>
   9 #include <stddef.h>
  10 #include <stdio.h>
  11 #include <stdlib.h>
  12 #include <string.h>
  13 #include <sys/stat.h>
  14 #include <linux/magic.h>
  15 #include <time.h>
  16 #include <unistd.h>
  17
  18 #include "alloc-util.h"
  19 #include "dirent-util.h"
  20 #include "fd-util.h"
  21 #include "fileio.h"
  22 #include "fs-util.h"
  23 //#include "log.h"
  24 //#include "macro.h"
  25 //#include "missing.h"
  26 #include "mkdir.h"
  27 #include "parse-util.h"
  28 #include "path-util.h"
  29 //#include "process-util.h"
  30 #include "stat-util.h"
  31 #include "stdio-util.h"
  32 #include "string-util.h"
  33 #include "strv.h"
  34 //#include "time-util.h"
  35 #include "user-util.h"
  36 #include "util.h"
  37
  38 /// Additional includes needed by elogind
  39 #include "process-util.h"
  40
  41 int unlink_noerrno(const char *path) {
  42         PROTECT_ERRNO;
  43         int r;
  44
  45         r = unlink(path);
  46         if (r < 0)
  47                 return -errno;
  48
  49         return 0;
  50 }
  51
  52 #if 0 /// UNNEEDED by elogind
  53 int rmdir_parents(const char *path, const char *stop) {
  54         size_t l;
  55         int r = 0;
  56
  57         assert(path);
  58         assert(stop);
  59
  60         l = strlen(path);
  61
  62         /* Skip trailing slashes */
  63         while (l > 0 && path[l-1] == '/')
  64                 l--;
  65
  66         while (l > 0) {
  67                 char *t;
  68
  69                 /* Skip last component */
  70                 while (l > 0 && path[l-1] != '/')
  71                         l--;
  72
  73                 /* Skip trailing slashes */
  74                 while (l > 0 && path[l-1] == '/')
  75                         l--;
  76
  77                 if (l <= 0)
  78                         break;
  79
  80                 t = strndup(path, l);
  81                 if (!t)
  82                         return -ENOMEM;
  83
  84                 if (path_startswith(stop, t)) {
  85                         free(t);
  86                         return 0;
  87                 }
  88
  89                 r = rmdir(t);
  90                 free(t);
  91
  92                 if (r < 0)
  93                         if (errno != ENOENT)
  94                                 return -errno;
  95         }
  96
  97         return 0;
  98 }
  99
 100 int rename_noreplace(int olddirfd, const char *oldpath, int newdirfd, const char *newpath) {
 101         struct stat buf;
 102         int ret;
 103
 104         ret = renameat2(olddirfd, oldpath, newdirfd, newpath, RENAME_NOREPLACE);
 105         if (ret >= 0)
 106                 return 0;
 107
 108         /* renameat2() exists since Linux 3.15, btrfs added support for it later.
 109          * If it is not implemented, fallback to another method. */
 110         if (!IN_SET(errno, EINVAL, ENOSYS))
 111                 return -errno;
 112
 113         /* The link()/unlink() fallback does not work on directories. But
 114          * renameat() without RENAME_NOREPLACE gives the same semantics on
 115          * directories, except when newpath is an *empty* directory. This is
 116          * good enough. */
 117         ret = fstatat(olddirfd, oldpath, &buf, AT_SYMLINK_NOFOLLOW);
 118         if (ret >= 0 && S_ISDIR(buf.st_mode)) {
 119                 ret = renameat(olddirfd, oldpath, newdirfd, newpath);
 120                 return ret >= 0 ? 0 : -errno;
 121         }
 122
 123         /* If it is not a directory, use the link()/unlink() fallback. */
 124         ret = linkat(olddirfd, oldpath, newdirfd, newpath, 0);
 125         if (ret < 0)
 126                 return -errno;
 127
 128         ret = unlinkat(olddirfd, oldpath, 0);
 129         if (ret < 0) {
 130                 /* backup errno before the following unlinkat() alters it */
 131                 ret = errno;
 132                 (void) unlinkat(newdirfd, newpath, 0);
 133                 errno = ret;
 134                 return -errno;
 135         }
 136
 137         return 0;
 138 }
 139 #endif // 0
 140
 141 int readlinkat_malloc(int fd, const char *p, char **ret) {
 142         size_t l = 100;
 143         int r;
 144
 145         assert(p);
 146         assert(ret);
 147
 148         for (;;) {
 149                 char *c;
 150                 ssize_t n;
 151
 152                 c = new(char, l);
 153                 if (!c)
 154                         return -ENOMEM;
 155
 156                 n = readlinkat(fd, p, c, l-1);
 157                 if (n < 0) {
 158                         r = -errno;
 159                         free(c);
 160                         return r;
 161                 }
 162
 163                 if ((size_t) n < l-1) {
 164                         c[n] = 0;
 165                         *ret = c;
 166                         return 0;
 167                 }
 168
 169                 free(c);
 170                 l *= 2;
 171         }
 172 }
 173
 174 int readlink_malloc(const char *p, char **ret) {
 175         return readlinkat_malloc(AT_FDCWD, p, ret);
 176 }
 177
 178 #if 0 /// UNNEEDED by elogind
 179 int readlink_value(const char *p, char **ret) {
 180         _cleanup_free_ char *link = NULL;
 181         char *value;
 182         int r;
 183
 184         r = readlink_malloc(p, &link);
 185         if (r < 0)
 186                 return r;
 187
 188         value = basename(link);
 189         if (!value)
 190                 return -ENOENT;
 191
 192         value = strdup(value);
 193         if (!value)
 194                 return -ENOMEM;
 195
 196         *ret = value;
 197
 198         return 0;
 199 }
 200 #endif // 0
 201
 202 int readlink_and_make_absolute(const char *p, char **r) {
 203         _cleanup_free_ char *target = NULL;
 204         char *k;
 205         int j;
 206
 207         assert(p);
 208         assert(r);
 209
 210         j = readlink_malloc(p, &target);
 211         if (j < 0)
 212                 return j;
 213
 214         k = file_in_same_dir(p, target);
 215         if (!k)
 216                 return -ENOMEM;
 217
 218         *r = k;
 219         return 0;
 220 }
 221
 222 #if 0 /// UNNEEDED by elogind
 223 #endif // 0
 224 int chmod_and_chown(const char *path, mode_t mode, uid_t uid, gid_t gid) {
 225         assert(path);
 226
 227         /* Under the assumption that we are running privileged we
 228          * first change the access mode and only then hand out
 229          * ownership to avoid a window where access is too open. */
 230
 231         if (mode != MODE_INVALID)
 232                 if (chmod(path, mode) < 0)
 233                         return -errno;
 234
 235         if (uid != UID_INVALID || gid != GID_INVALID)
 236                 if (chown(path, uid, gid) < 0)
 237                         return -errno;
 238
 239         return 0;
 240 }
 241
 242 int fchmod_umask(int fd, mode_t m) {
 243         mode_t u;
 244         int r;
 245
 246         u = umask(0777);
 247         r = fchmod(fd, m & (~u)) < 0 ? -errno : 0;
 248         umask(u);
 249
 250         return r;
 251 }
 252
 253 int fd_warn_permissions(const char *path, int fd) {
 254         struct stat st;
 255
 256         if (fstat(fd, &st) < 0)
 257                 return -errno;
 258
 259         if (st.st_mode & 0111)
 260                 log_warning("Configuration file %s is marked executable. Please remove executable permission bits. Proceeding anyway.", path);
 261
 262         if (st.st_mode & 0002)
 263                 log_warning("Configuration file %s is marked world-writable. Please remove world writability permission bits. Proceeding anyway.", path);
 264
 265         if (getpid_cached() == 1 && (st.st_mode & 0044) != 0044)
 266                 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);
 267
 268         return 0;
 269 }
 270
 271 int touch_file(const char *path, bool parents, usec_t stamp, uid_t uid, gid_t gid, mode_t mode) {
 272         char fdpath[STRLEN("/proc/self/fd/") + DECIMAL_STR_MAX(int)];
 273         _cleanup_close_ int fd = -1;
 274         int r, ret = 0;
 275
 276         assert(path);
 277
 278         /* Note that touch_file() does not follow symlinks: if invoked on an existing symlink, then it is the symlink
 279          * itself which is updated, not its target
 280          *
 281          * Returns the first error we encounter, but tries to apply as much as possible. */
 282
 283         if (parents)
 284                 (void) mkdir_parents(path, 0755);
 285
 286         /* Initially, we try to open the node with O_PATH, so that we get a reference to the node. This is useful in
 287          * case the path refers to an existing device or socket node, as we can open it successfully in all cases, and
 288          * won't trigger any driver magic or so. */
 289         fd = open(path, O_PATH|O_CLOEXEC|O_NOFOLLOW);
 290         if (fd < 0) {
 291                 if (errno != ENOENT)
 292                         return -errno;
 293
 294                 /* if the node doesn't exist yet, we create it, but with O_EXCL, so that we only create a regular file
 295                  * here, and nothing else */
 296                 fd = open(path, O_WRONLY|O_CREAT|O_EXCL|O_CLOEXEC, IN_SET(mode, 0, MODE_INVALID) ? 0644 : mode);
 297                 if (fd < 0)
 298                         return -errno;
 299         }
 300
 301         /* Let's make a path from the fd, and operate on that. With this logic, we can adjust the access mode,
 302          * ownership and time of the file node in all cases, even if the fd refers to an O_PATH object — which is
 303          * something fchown(), fchmod(), futimensat() don't allow. */
 304         xsprintf(fdpath, "/proc/self/fd/%i", fd);
 305
 306         if (mode != MODE_INVALID)
 307                 if (chmod(fdpath, mode) < 0)
 308                         ret = -errno;
 309
 310         if (uid_is_valid(uid) || gid_is_valid(gid))
 311                 if (chown(fdpath, uid, gid) < 0 && ret >= 0)
 312                         ret = -errno;
 313
 314         if (stamp != USEC_INFINITY) {
 315                 struct timespec ts[2];
 316
 317                 timespec_store(&ts[0], stamp);
 318                 ts[1] = ts[0];
 319                 r = utimensat(AT_FDCWD, fdpath, ts, 0);
 320         } else
 321                 r = utimensat(AT_FDCWD, fdpath, NULL, 0);
 322         if (r < 0 && ret >= 0)
 323                 return -errno;
 324
 325         return ret;
 326 }
 327
 328 int touch(const char *path) {
 329         return touch_file(path, false, USEC_INFINITY, UID_INVALID, GID_INVALID, MODE_INVALID);
 330 }
 331
 332 #if 0 /// UNNEEDED by elogind
 333 int symlink_idempotent(const char *from, const char *to) {
 334         int r;
 335
 336         assert(from);
 337         assert(to);
 338
 339         if (symlink(from, to) < 0) {
 340                 _cleanup_free_ char *p = NULL;
 341
 342                 if (errno != EEXIST)
 343                         return -errno;
 344
 345                 r = readlink_malloc(to, &p);
 346                 if (r == -EINVAL) /* Not a symlink? In that case return the original error we encountered: -EEXIST */
 347                         return -EEXIST;
 348                 if (r < 0) /* Any other error? In that case propagate it as is */
 349                         return r;
 350
 351                 if (!streq(p, from)) /* Not the symlink we want it to be? In that case, propagate the original -EEXIST */
 352                         return -EEXIST;
 353         }
 354
 355         return 0;
 356 }
 357
 358 int symlink_atomic(const char *from, const char *to) {
 359         _cleanup_free_ char *t = NULL;
 360         int r;
 361
 362         assert(from);
 363         assert(to);
 364
 365         r = tempfn_random(to, NULL, &t);
 366         if (r < 0)
 367                 return r;
 368
 369         if (symlink(from, t) < 0)
 370                 return -errno;
 371
 372         if (rename(t, to) < 0) {
 373                 unlink_noerrno(t);
 374                 return -errno;
 375         }
 376
 377         return 0;
 378 }
 379
 380 int mknod_atomic(const char *path, mode_t mode, dev_t dev) {
 381         _cleanup_free_ char *t = NULL;
 382         int r;
 383
 384         assert(path);
 385
 386         r = tempfn_random(path, NULL, &t);
 387         if (r < 0)
 388                 return r;
 389
 390         if (mknod(t, mode, dev) < 0)
 391                 return -errno;
 392
 393         if (rename(t, path) < 0) {
 394                 unlink_noerrno(t);
 395                 return -errno;
 396         }
 397
 398         return 0;
 399 }
 400
 401 int mkfifo_atomic(const char *path, mode_t mode) {
 402         _cleanup_free_ char *t = NULL;
 403         int r;
 404
 405         assert(path);
 406
 407         r = tempfn_random(path, NULL, &t);
 408         if (r < 0)
 409                 return r;
 410
 411         if (mkfifo(t, mode) < 0)
 412                 return -errno;
 413
 414         if (rename(t, path) < 0) {
 415                 unlink_noerrno(t);
 416                 return -errno;
 417         }
 418
 419         return 0;
 420 }
 421 #endif // 0
 422
 423 int get_files_in_directory(const char *path, char ***list) {
 424         _cleanup_closedir_ DIR *d = NULL;
 425         struct dirent *de;
 426         size_t bufsize = 0, n = 0;
 427         _cleanup_strv_free_ char **l = NULL;
 428
 429         assert(path);
 430
 431         /* Returns all files in a directory in *list, and the number
 432          * of files as return value. If list is NULL returns only the
 433          * number. */
 434
 435         d = opendir(path);
 436         if (!d)
 437                 return -errno;
 438
 439         FOREACH_DIRENT_ALL(de, d, return -errno) {
 440                 dirent_ensure_type(d, de);
 441
 442                 if (!dirent_is_file(de))
 443                         continue;
 444
 445                 if (list) {
 446                         /* one extra slot is needed for the terminating NULL */
 447                         if (!GREEDY_REALLOC(l, bufsize, n + 2))
 448                                 return -ENOMEM;
 449
 450                         l[n] = strdup(de->d_name);
 451                         if (!l[n])
 452                                 return -ENOMEM;
 453
 454                         l[++n] = NULL;
 455                 } else
 456                         n++;
 457         }
 458
 459         if (list)
 460                 *list = TAKE_PTR(l);
 461
 462         return n;
 463 }
 464
 465 static int getenv_tmp_dir(const char **ret_path) {
 466         const char *n;
 467         int r, ret = 0;
 468
 469         assert(ret_path);
 470
 471         /* We use the same order of environment variables python uses in tempfile.gettempdir():
 472          * https://docs.python.org/3/library/tempfile.html#tempfile.gettempdir */
 473         FOREACH_STRING(n, "TMPDIR", "TEMP", "TMP") {
 474                 const char *e;
 475
 476                 e = secure_getenv(n);
 477                 if (!e)
 478                         continue;
 479                 if (!path_is_absolute(e)) {
 480                         r = -ENOTDIR;
 481                         goto next;
 482                 }
 483                 if (!path_is_normalized(e)) {
 484                         r = -EPERM;
 485                         goto next;
 486                 }
 487
 488                 r = is_dir(e, true);
 489                 if (r < 0)
 490                         goto next;
 491                 if (r == 0) {
 492                         r = -ENOTDIR;
 493                         goto next;
 494                 }
 495
 496                 *ret_path = e;
 497                 return 1;
 498
 499         next:
 500                 /* Remember first error, to make this more debuggable */
 501                 if (ret >= 0)
 502                         ret = r;
 503         }
 504
 505         if (ret < 0)
 506                 return ret;
 507
 508         *ret_path = NULL;
 509         return ret;
 510 }
 511
 512 static int tmp_dir_internal(const char *def, const char **ret) {
 513         const char *e;
 514         int r, k;
 515
 516         assert(def);
 517         assert(ret);
 518
 519         r = getenv_tmp_dir(&e);
 520         if (r > 0) {
 521                 *ret = e;
 522                 return 0;
 523         }
 524
 525         k = is_dir(def, true);
 526         if (k == 0)
 527                 k = -ENOTDIR;
 528         if (k < 0)
 529                 return r < 0 ? r : k;
 530
 531         *ret = def;
 532         return 0;
 533 }
 534
 535 #if 0 /// UNNEEDED by elogind
 536 int var_tmp_dir(const char **ret) {
 537
 538         /* Returns the location for "larger" temporary files, that is backed by physical storage if available, and thus
 539          * even might survive a boot: /var/tmp. If $TMPDIR (or related environment variables) are set, its value is
 540          * returned preferably however. Note that both this function and tmp_dir() below are affected by $TMPDIR,
 541          * making it a variable that overrides all temporary file storage locations. */
 542
 543         return tmp_dir_internal("/var/tmp", ret);
 544 }
 545 #endif // 0
 546
 547 int tmp_dir(const char **ret) {
 548
 549         /* Similar to var_tmp_dir() above, but returns the location for "smaller" temporary files, which is usually
 550          * backed by an in-memory file system: /tmp. */
 551
 552         return tmp_dir_internal("/tmp", ret);
 553 }
 554
 555 int unlink_or_warn(const char *filename) {
 556         if (unlink(filename) < 0 && errno != ENOENT)
 557                 /* If the file doesn't exist and the fs simply was read-only (in which
 558                  * case unlink() returns EROFS even if the file doesn't exist), don't
 559                  * complain */
 560                 if (errno != EROFS || access(filename, F_OK) >= 0)
 561                         return log_error_errno(errno, "Failed to remove \"%s\": %m", filename);
 562
 563         return 0;
 564 }
 565
 566 #if 0 /// UNNEEDED by elogind
 567 int inotify_add_watch_fd(int fd, int what, uint32_t mask) {
 568         char path[STRLEN("/proc/self/fd/") + DECIMAL_STR_MAX(int) + 1];
 569         int r;
 570
 571         /* This is like inotify_add_watch(), except that the file to watch is not referenced by a path, but by an fd */
 572         xsprintf(path, "/proc/self/fd/%i", what);
 573
 574         r = inotify_add_watch(fd, path, mask);
 575         if (r < 0)
 576                 return -errno;
 577
 578         return r;
 579 }
 580 #endif // 0
 581
 582 static bool safe_transition(const struct stat *a, const struct stat *b) {
 583         /* Returns true if the transition from a to b is safe, i.e. that we never transition from unprivileged to
 584          * privileged files or directories. Why bother? So that unprivileged code can't symlink to privileged files
 585          * making us believe we read something safe even though it isn't safe in the specific context we open it in. */
 586
 587         if (a->st_uid == 0) /* Transitioning from privileged to unprivileged is always fine */
 588                 return true;
 589
 590         return a->st_uid == b->st_uid; /* Otherwise we need to stay within the same UID */
 591 }
 592
 593 int chase_symlinks(const char *path, const char *original_root, unsigned flags, char **ret) {
 594         _cleanup_free_ char *buffer = NULL, *done = NULL, *root = NULL;
 595         _cleanup_close_ int fd = -1;
 596         unsigned max_follow = 32; /* how many symlinks to follow before giving up and returning ELOOP */
 597         struct stat previous_stat;
 598         bool exists = true;
 599         char *todo;
 600         int r;
 601
 602         assert(path);
 603
 604         /* Either the file may be missing, or we return an fd to the final object, but both make no sense */
 605         if ((flags & (CHASE_NONEXISTENT|CHASE_OPEN)) == (CHASE_NONEXISTENT|CHASE_OPEN))
 606                 return -EINVAL;
 607
 608         if (isempty(path))
 609                 return -EINVAL;
 610
 611         /* This is a lot like canonicalize_file_name(), but takes an additional "root" parameter, that allows following
 612          * symlinks relative to a root directory, instead of the root of the host.
 613          *
 614          * Note that "root" primarily matters if we encounter an absolute symlink. It is also used when following
 615          * relative symlinks to ensure they cannot be used to "escape" the root directory. The path parameter passed is
 616          * assumed to be already prefixed by it, except if the CHASE_PREFIX_ROOT flag is set, in which case it is first
 617          * prefixed accordingly.
 618          *
 619          * Algorithmically this operates on two path buffers: "done" are the components of the path we already
 620          * processed and resolved symlinks, "." and ".." of. "todo" are the components of the path we still need to
 621          * process. On each iteration, we move one component from "todo" to "done", processing it's special meaning
 622          * each time. The "todo" path always starts with at least one slash, the "done" path always ends in no
 623          * slash. We always keep an O_PATH fd to the component we are currently processing, thus keeping lookup races
 624          * at a minimum.
 625          *
 626          * Suggested usage: whenever you want to canonicalize a path, use this function. Pass the absolute path you got
 627          * as-is: fully qualified and relative to your host's root. Optionally, specify the root parameter to tell this
 628          * function what to do when encountering a symlink with an absolute path as directory: prefix it by the
 629          * specified path. */
 630
 631         /* A root directory of "/" or "" is identical to none */
 632         if (empty_or_root(original_root))
 633                 original_root = NULL;
 634
 635         if (!original_root && !ret && (flags & (CHASE_NONEXISTENT|CHASE_NO_AUTOFS|CHASE_SAFE|CHASE_OPEN)) == CHASE_OPEN) {
 636                 /* Shortcut the CHASE_OPEN case if the caller isn't interested in the actual path and has no root set
 637                  * and doesn't care about any of the other special features we provide either. */
 638                 r = open(path, O_PATH|O_CLOEXEC);
 639                 if (r < 0)
 640                         return -errno;
 641
 642                 return r;
 643         }
 644
 645         if (original_root) {
 646                 r = path_make_absolute_cwd(original_root, &root);
 647                 if (r < 0)
 648                         return r;
 649
 650                 if (flags & CHASE_PREFIX_ROOT) {
 651
 652                         /* We don't support relative paths in combination with a root directory */
 653                         if (!path_is_absolute(path))
 654                                 return -EINVAL;
 655
 656                         path = prefix_roota(root, path);
 657                 }
 658         }
 659
 660         r = path_make_absolute_cwd(path, &buffer);
 661         if (r < 0)
 662                 return r;
 663
 664         fd = open("/", O_CLOEXEC|O_NOFOLLOW|O_PATH);
 665         if (fd < 0)
 666                 return -errno;
 667
 668         if (flags & CHASE_SAFE) {
 669                 if (fstat(fd, &previous_stat) < 0)
 670                         return -errno;
 671         }
 672
 673         todo = buffer;
 674         for (;;) {
 675                 _cleanup_free_ char *first = NULL;
 676                 _cleanup_close_ int child = -1;
 677                 struct stat st;
 678                 size_t n, m;
 679
 680                 /* Determine length of first component in the path */
 681                 n = strspn(todo, "/");                  /* The slashes */
 682                 m = n + strcspn(todo + n, "/");         /* The entire length of the component */
 683
 684                 /* Extract the first component. */
 685                 first = strndup(todo, m);
 686                 if (!first)
 687                         return -ENOMEM;
 688
 689                 todo += m;
 690
 691                 /* Empty? Then we reached the end. */
 692                 if (isempty(first))
 693                         break;
 694
 695                 /* Just a single slash? Then we reached the end. */
 696                 if (path_equal(first, "/")) {
 697                         /* Preserve the trailing slash */
 698
 699                         if (flags & CHASE_TRAIL_SLASH)
 700                                 if (!strextend(&done, "/", NULL))
 701                                         return -ENOMEM;
 702
 703                         break;
 704                 }
 705
 706                 /* Just a dot? Then let's eat this up. */
 707                 if (path_equal(first, "/."))
 708                         continue;
 709
 710                 /* Two dots? Then chop off the last bit of what we already found out. */
 711                 if (path_equal(first, "/..")) {
 712                         _cleanup_free_ char *parent = NULL;
 713                         _cleanup_close_ int fd_parent = -1;
 714
 715                         /* If we already are at the top, then going up will not change anything. This is in-line with
 716                          * how the kernel handles this. */
 717                         if (empty_or_root(done))
 718                                 continue;
 719
 720                         parent = dirname_malloc(done);
 721                         if (!parent)
 722                                 return -ENOMEM;
 723
 724                         /* Don't allow this to leave the root dir.  */
 725                         if (root &&
 726                             path_startswith(done, root) &&
 727                             !path_startswith(parent, root))
 728                                 continue;
 729
 730                         free_and_replace(done, parent);
 731
 732                         fd_parent = openat(fd, "..", O_CLOEXEC|O_NOFOLLOW|O_PATH);
 733                         if (fd_parent < 0)
 734                                 return -errno;
 735
 736                         if (flags & CHASE_SAFE) {
 737                                 if (fstat(fd_parent, &st) < 0)
 738                                         return -errno;
 739
 740                                 if (!safe_transition(&previous_stat, &st))
 741                                         return -EPERM;
 742
 743                                 previous_stat = st;
 744                         }
 745
 746                         safe_close(fd);
 747                         fd = TAKE_FD(fd_parent);
 748
 749                         continue;
 750                 }
 751
 752                 /* Otherwise let's see what this is. */
 753                 child = openat(fd, first + n, O_CLOEXEC|O_NOFOLLOW|O_PATH);
 754                 if (child < 0) {
 755
 756                         if (errno == ENOENT &&
 757                             (flags & CHASE_NONEXISTENT) &&
 758                             (isempty(todo) || path_is_normalized(todo))) {
 759
 760                                 /* If CHASE_NONEXISTENT is set, and the path does not exist, then that's OK, return
 761                                  * what we got so far. But don't allow this if the remaining path contains "../ or "./"
 762                                  * or something else weird. */
 763
 764                                 /* If done is "/", as first also contains slash at the head, then remove this redundant slash. */
 765                                 if (streq_ptr(done, "/"))
 766                                         *done = '\0';
 767
 768                                 if (!strextend(&done, first, todo, NULL))
 769                                         return -ENOMEM;
 770
 771                                 exists = false;
 772                                 break;
 773                         }
 774
 775                         return -errno;
 776                 }
 777
 778                 if (fstat(child, &st) < 0)
 779                         return -errno;
 780                 if ((flags & CHASE_SAFE) &&
 781                     !safe_transition(&previous_stat, &st))
 782                         return -EPERM;
 783
 784                 previous_stat = st;
 785
 786                 if ((flags & CHASE_NO_AUTOFS) &&
 787                     fd_is_fs_type(child, AUTOFS_SUPER_MAGIC) > 0)
 788                         return -EREMOTE;
 789
 790                 if (S_ISLNK(st.st_mode)) {
 791                         char *joined;
 792
 793                         _cleanup_free_ char *destination = NULL;
 794
 795                         /* This is a symlink, in this case read the destination. But let's make sure we don't follow
 796                          * symlinks without bounds. */
 797                         if (--max_follow <= 0)
 798                                 return -ELOOP;
 799
 800                         r = readlinkat_malloc(fd, first + n, &destination);
 801                         if (r < 0)
 802                                 return r;
 803                         if (isempty(destination))
 804                                 return -EINVAL;
 805
 806                         if (path_is_absolute(destination)) {
 807
 808                                 /* An absolute destination. Start the loop from the beginning, but use the root
 809                                  * directory as base. */
 810
 811                                 safe_close(fd);
 812                                 fd = open(root ?: "/", O_CLOEXEC|O_NOFOLLOW|O_PATH);
 813                                 if (fd < 0)
 814                                         return -errno;
 815
 816                                 if (flags & CHASE_SAFE) {
 817                                         if (fstat(fd, &st) < 0)
 818                                                 return -errno;
 819
 820                                         if (!safe_transition(&previous_stat, &st))
 821                                                 return -EPERM;
 822
 823                                         previous_stat = st;
 824                                 }
 825
 826                                 free(done);
 827
 828                                 /* Note that we do not revalidate the root, we take it as is. */
 829                                 if (isempty(root))
 830                                         done = NULL;
 831                                 else {
 832                                         done = strdup(root);
 833                                         if (!done)
 834                                                 return -ENOMEM;
 835                                 }
 836
 837                                 /* Prefix what's left to do with what we just read, and start the loop again, but
 838                                  * remain in the current directory. */
 839                                 joined = strjoin(destination, todo);
 840                         } else
 841                                 joined = strjoin("/", destination, todo);
 842                         if (!joined)
 843                                 return -ENOMEM;
 844
 845                         free(buffer);
 846                         todo = buffer = joined;
 847
 848                         continue;
 849                 }
 850
 851                 /* If this is not a symlink, then let's just add the name we read to what we already verified. */
 852                 if (!done)
 853                         done = TAKE_PTR(first);
 854                 else {
 855                         /* If done is "/", as first also contains slash at the head, then remove this redundant slash. */
 856                         if (streq(done, "/"))
 857                                 *done = '\0';
 858
 859                         if (!strextend(&done, first, NULL))
 860                                 return -ENOMEM;
 861                 }
 862
 863                 /* And iterate again, but go one directory further down. */
 864                 safe_close(fd);
 865                 fd = TAKE_FD(child);
 866         }
 867
 868         if (!done) {
 869                 /* Special case, turn the empty string into "/", to indicate the root directory. */
 870                 done = strdup("/");
 871                 if (!done)
 872                         return -ENOMEM;
 873         }
 874
 875         if (ret)
 876                 *ret = TAKE_PTR(done);
 877
 878         if (flags & CHASE_OPEN) {
 879                 /* Return the O_PATH fd we currently are looking to the caller. It can translate it to a proper fd by
 880                  * opening /proc/self/fd/xyz. */
 881
 882                 assert(fd >= 0);
 883                 return TAKE_FD(fd);
 884         }
 885
 886         return exists;
 887 }
 888
 889 int chase_symlinks_and_open(
 890                 const char *path,
 891                 const char *root,
 892                 unsigned chase_flags,
 893                 int open_flags,
 894                 char **ret_path) {
 895
 896         _cleanup_close_ int path_fd = -1;
 897         _cleanup_free_ char *p = NULL;
 898         int r;
 899
 900         if (chase_flags & CHASE_NONEXISTENT)
 901                 return -EINVAL;
 902
 903         if (empty_or_root(root) && !ret_path && (chase_flags & (CHASE_NO_AUTOFS|CHASE_SAFE)) == 0) {
 904                 /* Shortcut this call if none of the special features of this call are requested */
 905                 r = open(path, open_flags);
 906                 if (r < 0)
 907                         return -errno;
 908
 909                 return r;
 910         }
 911
 912         path_fd = chase_symlinks(path, root, chase_flags|CHASE_OPEN, ret_path ? &p : NULL);
 913         if (path_fd < 0)
 914                 return path_fd;
 915
 916         r = fd_reopen(path_fd, open_flags);
 917         if (r < 0)
 918                 return r;
 919
 920         if (ret_path)
 921                 *ret_path = TAKE_PTR(p);
 922
 923         return r;
 924 }
 925
 926 int chase_symlinks_and_opendir(
 927                 const char *path,
 928                 const char *root,
 929                 unsigned chase_flags,
 930                 char **ret_path,
 931                 DIR **ret_dir) {
 932
 933         char procfs_path[STRLEN("/proc/self/fd/") + DECIMAL_STR_MAX(int)];
 934         _cleanup_close_ int path_fd = -1;
 935         _cleanup_free_ char *p = NULL;
 936         DIR *d;
 937
 938         if (!ret_dir)
 939                 return -EINVAL;
 940         if (chase_flags & CHASE_NONEXISTENT)
 941                 return -EINVAL;
 942
 943         if (empty_or_root(root) && !ret_path && (chase_flags & (CHASE_NO_AUTOFS|CHASE_SAFE)) == 0) {
 944                 /* Shortcut this call if none of the special features of this call are requested */
 945                 d = opendir(path);
 946                 if (!d)
 947                         return -errno;
 948
 949                 *ret_dir = d;
 950                 return 0;
 951         }
 952
 953         path_fd = chase_symlinks(path, root, chase_flags|CHASE_OPEN, ret_path ? &p : NULL);
 954         if (path_fd < 0)
 955                 return path_fd;
 956
 957         xsprintf(procfs_path, "/proc/self/fd/%i", path_fd);
 958         d = opendir(procfs_path);
 959         if (!d)
 960                 return -errno;
 961
 962         if (ret_path)
 963                 *ret_path = TAKE_PTR(p);
 964
 965         *ret_dir = d;
 966         return 0;
 967 }
 968
 969 int chase_symlinks_and_stat(
 970                 const char *path,
 971                 const char *root,
 972                 unsigned chase_flags,
 973                 char **ret_path,
 974                 struct stat *ret_stat) {
 975
 976         _cleanup_close_ int path_fd = -1;
 977         _cleanup_free_ char *p = NULL;
 978
 979         assert(path);
 980         assert(ret_stat);
 981
 982         if (chase_flags & CHASE_NONEXISTENT)
 983                 return -EINVAL;
 984
 985         if (empty_or_root(root) && !ret_path && (chase_flags & (CHASE_NO_AUTOFS|CHASE_SAFE)) == 0) {
 986                 /* Shortcut this call if none of the special features of this call are requested */
 987                 if (stat(path, ret_stat) < 0)
 988                         return -errno;
 989
 990                 return 1;
 991         }
 992
 993         path_fd = chase_symlinks(path, root, chase_flags|CHASE_OPEN, ret_path ? &p : NULL);
 994         if (path_fd < 0)
 995                 return path_fd;
 996
 997         if (fstat(path_fd, ret_stat) < 0)
 998                 return -errno;
 999
1000         if (ret_path)
1001                 *ret_path = TAKE_PTR(p);
1002
1003         if (chase_flags & CHASE_OPEN)
1004                 return TAKE_FD(path_fd);
1005
1006         return 1;
1007 }
1008
1009 int access_fd(int fd, int mode) {
1010         char p[STRLEN("/proc/self/fd/") + DECIMAL_STR_MAX(fd) + 1];
1011         int r;
1012
1013         /* Like access() but operates on an already open fd */
1014
1015         xsprintf(p, "/proc/self/fd/%i", fd);
1016         r = access(p, mode);
1017         if (r < 0)
1018                 return -errno;
1019
1020         return r;
1021 }
1022
1023 int unlinkat_deallocate(int fd, const char *name, int flags) {
1024         _cleanup_close_ int truncate_fd = -1;
1025         struct stat st;
1026         off_t l, bs;
1027
1028         /* Operates like unlinkat() but also deallocates the file contents if it is a regular file and there's no other
1029          * link to it. This is useful to ensure that other processes that might have the file open for reading won't be
1030          * able to keep the data pinned on disk forever. This call is particular useful whenever we execute clean-up
1031          * jobs ("vacuuming"), where we want to make sure the data is really gone and the disk space released and
1032          * returned to the free pool.
1033          *
1034          * Deallocation is preferably done by FALLOC_FL_PUNCH_HOLE|FALLOC_FL_KEEP_SIZE (👊) if supported, which means
1035          * the file won't change size. That's a good thing since we shouldn't needlessly trigger SIGBUS in other
1036          * programs that have mmap()ed the file. (The assumption here is that changing file contents to all zeroes
1037          * underneath those programs is the better choice than simply triggering SIGBUS in them which truncation does.)
1038          * However if hole punching is not implemented in the kernel or file system we'll fall back to normal file
1039          * truncation (🔪), as our goal of deallocating the data space trumps our goal of being nice to readers (💐).
1040          *
1041          * Note that we attempt deallocation, but failure to succeed with that is not considered fatal, as long as the
1042          * primary job – to delete the file – is accomplished. */
1043
1044         if ((flags & AT_REMOVEDIR) == 0) {
1045                 truncate_fd = openat(fd, name, O_WRONLY|O_CLOEXEC|O_NOCTTY|O_NOFOLLOW|O_NONBLOCK);
1046                 if (truncate_fd < 0) {
1047
1048                         /* If this failed because the file doesn't exist propagate the error right-away. Also,
1049                          * AT_REMOVEDIR wasn't set, and we tried to open the file for writing, which means EISDIR is
1050                          * returned when this is a directory but we are not supposed to delete those, hence propagate
1051                          * the error right-away too. */
1052                         if (IN_SET(errno, ENOENT, EISDIR))
1053                                 return -errno;
1054
1055                         if (errno != ELOOP) /* don't complain if this is a symlink */
1056                                 log_debug_errno(errno, "Failed to open file '%s' for deallocation, ignoring: %m", name);
1057                 }
1058         }
1059
1060         if (unlinkat(fd, name, flags) < 0)
1061                 return -errno;
1062
1063         if (truncate_fd < 0) /* Don't have a file handle, can't do more ☹️ */
1064                 return 0;
1065
1066         if (fstat(truncate_fd, &st) < 0) {
1067                 log_debug_errno(errno, "Failed to stat file '%s' for deallocation, ignoring.", name);
1068                 return 0;
1069         }
1070
1071         if (!S_ISREG(st.st_mode) || st.st_blocks == 0 || st.st_nlink > 0)
1072                 return 0;
1073
1074         /* If this is a regular file, it actually took up space on disk and there are no other links it's time to
1075          * punch-hole/truncate this to release the disk space. */
1076
1077         bs = MAX(st.st_blksize, 512);
1078         l = DIV_ROUND_UP(st.st_size, bs) * bs; /* Round up to next block size */
1079
1080         if (fallocate(truncate_fd, FALLOC_FL_PUNCH_HOLE|FALLOC_FL_KEEP_SIZE, 0, l) >= 0)
1081                 return 0; /* Successfully punched a hole! 😊 */
1082
1083         /* Fall back to truncation */
1084         if (ftruncate(truncate_fd, 0) < 0) {
1085                 log_debug_errno(errno, "Failed to truncate file to 0, ignoring: %m");
1086                 return 0;
1087         }
1088
1089         return 0;
1090 }
1091
1092 int fsync_directory_of_file(int fd) {
1093         _cleanup_free_ char *path = NULL, *dn = NULL;
1094         _cleanup_close_ int dfd = -1;
1095         int r;
1096
1097         r = fd_verify_regular(fd);
1098         if (r < 0)
1099                 return r;
1100
1101         r = fd_get_path(fd, &path);
1102         if (r < 0) {
1103                 log_debug("Failed to query /proc/self/fd/%d%s: %m",
1104                           fd,
1105                           r == -EOPNOTSUPP ? ", ignoring" : "");
1106
1107                 if (r == -EOPNOTSUPP)
1108                         /* If /proc is not available, we're most likely running in some
1109                          * chroot environment, and syncing the directory is not very
1110                          * important in that case. Let's just silently do nothing. */
1111                         return 0;
1112
1113                 return r;
1114         }
1115
1116         if (!path_is_absolute(path))
1117                 return -EINVAL;
1118
1119         dn = dirname_malloc(path);
1120         if (!dn)
1121                 return -ENOMEM;
1122
1123         dfd = open(dn, O_RDONLY|O_CLOEXEC|O_DIRECTORY);
1124         if (dfd < 0)
1125                 return -errno;
1126
1127         if (fsync(dfd) < 0)
1128                 return -errno;
1129
1130         return 0;
1131 }