src/boot/bootctl.c

   1 /* SPDX-License-Identifier: LGPL-2.1+ */
   2
   3 #include <blkid.h>
   4 #include <ctype.h>
   5 #include <dirent.h>
   6 #include <errno.h>
   7 #include <ftw.h>
   8 #include <getopt.h>
   9 #include <limits.h>
  10 #include <linux/magic.h>
  11 #include <stdbool.h>
  12 #include <stdio.h>
  13 #include <stdlib.h>
  14 #include <string.h>
  15 #include <sys/mman.h>
  16 #include <sys/stat.h>
  17 #include <sys/statfs.h>
  18 #include <unistd.h>
  19
  20 #include "sd-id128.h"
  21
  22 #include "alloc-util.h"
  23 #include "blkid-util.h"
  24 #include "bootspec.h"
  25 #include "copy.h"
  26 #include "dirent-util.h"
  27 #include "efivars.h"
  28 #include "fd-util.h"
  29 #include "fileio.h"
  30 #include "fs-util.h"
  31 #include "locale-util.h"
  32 #include "main-func.h"
  33 #include "pager.h"
  34 #include "parse-util.h"
  35 #include "pretty-print.h"
  36 #include "rm-rf.h"
  37 #include "stat-util.h"
  38 #include "string-util.h"
  39 #include "strv.h"
  40 #include "terminal-util.h"
  41 #include "umask-util.h"
  42 #include "utf8.h"
  43 #include "util.h"
  44 #include "verbs.h"
  45 #include "virt.h"
  46
  47 static char *arg_path = NULL;
  48 static bool arg_print_path = false;
  49 static bool arg_touch_variables = true;
  50 static PagerFlags arg_pager_flags = 0;
  51
  52 STATIC_DESTRUCTOR_REGISTER(arg_path, freep);
  53
  54 static int acquire_esp(
  55                 bool unprivileged_mode,
  56                 uint32_t *ret_part,
  57                 uint64_t *ret_pstart,
  58                 uint64_t *ret_psize,
  59                 sd_id128_t *ret_uuid) {
  60
  61         char *np;
  62         int r;
  63
  64         /* Find the ESP, and log about errors. Note that find_esp_and_warn() will log in all error cases on its own,
  65          * except for ENOKEY (which is good, we want to show our own message in that case, suggesting use of --path=)
  66          * and EACCESS (only when we request unprivileged mode; in this case we simply eat up the error here, so that
  67          * --list and --status work too, without noise about this). */
  68
  69         r = find_esp_and_warn(arg_path, unprivileged_mode, &np, ret_part, ret_pstart, ret_psize, ret_uuid);
  70         if (r == -ENOKEY)
  71                 return log_error_errno(r,
  72                                        "Couldn't find EFI system partition. It is recommended to mount it to /boot or /efi.\n"
  73                                        "Alternatively, use --path= to specify path to mount point.");
  74         if (r < 0)
  75                 return r;
  76
  77         free_and_replace(arg_path, np);
  78
  79         log_debug("Using EFI System Partition at %s.", arg_path);
  80
  81         return 0;
  82 }
  83
  84 /* search for "#### LoaderInfo: systemd-boot 218 ####" string inside the binary */
  85 static int get_file_version(int fd, char **v) {
  86         struct stat st;
  87         char *buf;
  88         const char *s, *e;
  89         char *x = NULL;
  90         int r = 0;
  91
  92         assert(fd >= 0);
  93         assert(v);
  94
  95         if (fstat(fd, &st) < 0)
  96                 return log_error_errno(errno, "Failed to stat EFI binary: %m");
  97
  98         if (st.st_size < 27) {
  99                 *v = NULL;
 100                 return 0;
 101         }
 102
 103         buf = mmap(NULL, st.st_size, PROT_READ, MAP_PRIVATE, fd, 0);
 104         if (buf == MAP_FAILED)
 105                 return log_error_errno(errno, "Failed to memory map EFI binary: %m");
 106
 107         s = memmem(buf, st.st_size - 8, "#### LoaderInfo: ", 17);
 108         if (!s)
 109                 goto finish;
 110         s += 17;
 111
 112         e = memmem(s, st.st_size - (s - buf), " ####", 5);
 113         if (!e || e - s < 3) {
 114                 log_error("Malformed version string.");
 115                 r = -EINVAL;
 116                 goto finish;
 117         }
 118
 119         x = strndup(s, e - s);
 120         if (!x) {
 121                 r = log_oom();
 122                 goto finish;
 123         }
 124         r = 1;
 125
 126 finish:
 127         (void) munmap(buf, st.st_size);
 128         *v = x;
 129         return r;
 130 }
 131
 132 static int enumerate_binaries(const char *esp_path, const char *path, const char *prefix) {
 133         char *p;
 134         _cleanup_closedir_ DIR *d = NULL;
 135         struct dirent *de;
 136         int r = 0, c = 0;
 137
 138         p = strjoina(esp_path, "/", path);
 139         d = opendir(p);
 140         if (!d) {
 141                 if (errno == ENOENT)
 142                         return 0;
 143
 144                 return log_error_errno(errno, "Failed to read \"%s\": %m", p);
 145         }
 146
 147         FOREACH_DIRENT(de, d, break) {
 148                 _cleanup_close_ int fd = -1;
 149                 _cleanup_free_ char *v = NULL;
 150
 151                 if (!endswith_no_case(de->d_name, ".efi"))
 152                         continue;
 153
 154                 if (prefix && !startswith_no_case(de->d_name, prefix))
 155                         continue;
 156
 157                 fd = openat(dirfd(d), de->d_name, O_RDONLY|O_CLOEXEC);
 158                 if (fd < 0)
 159                         return log_error_errno(errno, "Failed to open \"%s/%s\" for reading: %m", p, de->d_name);
 160
 161                 r = get_file_version(fd, &v);
 162                 if (r < 0)
 163                         return r;
 164                 if (r > 0)
 165                         printf("         File: %s/%s/%s (%s%s%s)\n", special_glyph(TREE_RIGHT), path, de->d_name, ansi_highlight(), v, ansi_normal());
 166                 else
 167                         printf("         File: %s/%s/%s\n", special_glyph(TREE_RIGHT), path, de->d_name);
 168                 c++;
 169         }
 170
 171         return c;
 172 }
 173
 174 static int status_binaries(const char *esp_path, sd_id128_t partition) {
 175         int r;
 176
 177         printf("Available Boot Loaders on ESP:\n");
 178
 179         if (!esp_path) {
 180                 printf("          ESP: Cannot find or access mount point of ESP.\n\n");
 181                 return -ENOENT;
 182         }
 183
 184         printf("          ESP: %s", esp_path);
 185         if (!sd_id128_is_null(partition))
 186                 printf(" (/dev/disk/by-partuuid/%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x)", SD_ID128_FORMAT_VAL(partition));
 187         printf("\n");
 188
 189         r = enumerate_binaries(esp_path, "EFI/systemd", NULL);
 190         if (r == 0)
 191                 log_info("systemd-boot not installed in ESP.");
 192         else if (r < 0)
 193                 return r;
 194
 195         r = enumerate_binaries(esp_path, "EFI/BOOT", "boot");
 196         if (r == 0)
 197                 log_info("No default/fallback boot loader installed in ESP.");
 198         else if (r < 0)
 199                 return r;
 200
 201         printf("\n");
 202
 203         return 0;
 204 }
 205
 206 static int print_efi_option(uint16_t id, bool in_order) {
 207         _cleanup_free_ char *title = NULL;
 208         _cleanup_free_ char *path = NULL;
 209         sd_id128_t partition;
 210         bool active;
 211         int r = 0;
 212
 213         r = efi_get_boot_option(id, &title, &partition, &path, &active);
 214         if (r < 0)
 215                 return r;
 216
 217         /* print only configured entries with partition information */
 218         if (!path || sd_id128_is_null(partition))
 219                 return 0;
 220
 221         efi_tilt_backslashes(path);
 222
 223         printf("        Title: %s%s%s\n", ansi_highlight(), strna(title), ansi_normal());
 224         printf("           ID: 0x%04X\n", id);
 225         printf("       Status: %sactive%s\n", active ? "" : "in", in_order ? ", boot-order" : "");
 226         printf("    Partition: /dev/disk/by-partuuid/%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x\n", SD_ID128_FORMAT_VAL(partition));
 227         printf("         File: %s%s\n", special_glyph(TREE_RIGHT), path);
 228         printf("\n");
 229
 230         return 0;
 231 }
 232
 233 static int status_variables(void) {
 234         _cleanup_free_ uint16_t *options = NULL, *order = NULL;
 235         int n_options, n_order, i;
 236
 237         n_options = efi_get_boot_options(&options);
 238         if (n_options == -ENOENT)
 239                 return log_error_errno(n_options,
 240                                        "Failed to access EFI variables, efivarfs"
 241                                        " needs to be available at /sys/firmware/efi/efivars/.");
 242         if (n_options < 0)
 243                 return log_error_errno(n_options, "Failed to read EFI boot entries: %m");
 244
 245         n_order = efi_get_boot_order(&order);
 246         if (n_order == -ENOENT)
 247                 n_order = 0;
 248         else if (n_order < 0)
 249                 return log_error_errno(n_order, "Failed to read EFI boot order: %m");
 250
 251         /* print entries in BootOrder first */
 252         printf("Boot Loaders Listed in EFI Variables:\n");
 253         for (i = 0; i < n_order; i++)
 254                 print_efi_option(order[i], true);
 255
 256         /* print remaining entries */
 257         for (i = 0; i < n_options; i++) {
 258                 int j;
 259
 260                 for (j = 0; j < n_order; j++)
 261                         if (options[i] == order[j])
 262                                 goto next_option;
 263
 264                 print_efi_option(options[i], false);
 265
 266         next_option:
 267                 continue;
 268         }
 269
 270         return 0;
 271 }
 272
 273 static int boot_entry_show(const BootEntry *e, bool show_as_default) {
 274         assert(e);
 275
 276         printf("        title: %s%s%s%s%s%s\n",
 277                ansi_highlight(),
 278                boot_entry_title(e),
 279                ansi_normal(),
 280                ansi_highlight_green(),
 281                show_as_default ? " (default)" : "",
 282                ansi_normal());
 283
 284         if (e->id)
 285                 printf("           id: %s\n", e->id);
 286         if (e->version)
 287                 printf("      version: %s\n", e->version);
 288         if (e->machine_id)
 289                 printf("   machine-id: %s\n", e->machine_id);
 290         if (e->architecture)
 291                 printf(" architecture: %s\n", e->architecture);
 292         if (e->kernel)
 293                 printf("        linux: %s\n", e->kernel);
 294         if (!strv_isempty(e->initrd)) {
 295                 _cleanup_free_ char *t;
 296
 297                 t = strv_join(e->initrd, " ");
 298                 if (!t)
 299                         return log_oom();
 300
 301                 printf("       initrd: %s\n", t);
 302         }
 303         if (!strv_isempty(e->options)) {
 304                 _cleanup_free_ char *t;
 305
 306                 t = strv_join(e->options, " ");
 307                 if (!t)
 308                         return log_oom();
 309
 310                 printf("      options: %s\n", t);
 311         }
 312         if (e->device_tree)
 313                 printf("   devicetree: %s\n", e->device_tree);
 314
 315         return 0;
 316 }
 317
 318 static int status_entries(const char *esp_path, sd_id128_t partition) {
 319         _cleanup_(boot_config_free) BootConfig config = {};
 320         int r;
 321
 322         r = boot_entries_load_config(esp_path, &config);
 323         if (r < 0)
 324                 return r;
 325
 326         if (config.default_entry < 0)
 327                 printf("%zu entries, no entry could be determined as default.\n", config.n_entries);
 328         else {
 329                 printf("Default Boot Loader Entry:\n");
 330
 331                 boot_entry_show(config.entries + config.default_entry, false);
 332         }
 333
 334         return 0;
 335 }
 336
 337 static int compare_product(const char *a, const char *b) {
 338         size_t x, y;
 339
 340         assert(a);
 341         assert(b);
 342
 343         x = strcspn(a, " ");
 344         y = strcspn(b, " ");
 345         if (x != y)
 346                 return x < y ? -1 : x > y ? 1 : 0;
 347
 348         return strncmp(a, b, x);
 349 }
 350
 351 static int compare_version(const char *a, const char *b) {
 352         assert(a);
 353         assert(b);
 354
 355         a += strcspn(a, " ");
 356         a += strspn(a, " ");
 357         b += strcspn(b, " ");
 358         b += strspn(b, " ");
 359
 360         return strverscmp(a, b);
 361 }
 362
 363 static int version_check(int fd_from, const char *from, int fd_to, const char *to) {
 364         _cleanup_free_ char *a = NULL, *b = NULL;
 365         int r;
 366
 367         assert(fd_from >= 0);
 368         assert(from);
 369         assert(fd_to >= 0);
 370         assert(to);
 371
 372         r = get_file_version(fd_from, &a);
 373         if (r < 0)
 374                 return r;
 375         if (r == 0)
 376                 return log_error_errno(SYNTHETIC_ERRNO(EINVAL),
 377                                        "Source file \"%s\" does not carry version information!",
 378                                        from);
 379
 380         r = get_file_version(fd_to, &b);
 381         if (r < 0)
 382                 return r;
 383         if (r == 0 || compare_product(a, b) != 0)
 384                 return log_notice_errno(SYNTHETIC_ERRNO(EEXIST),
 385                                         "Skipping \"%s\", since it's owned by another boot loader.",
 386                                         to);
 387
 388         if (compare_version(a, b) < 0) {
 389                 log_warning("Skipping \"%s\", since a newer boot loader version exists already.", to);
 390                 return -ESTALE;
 391         }
 392
 393         return 0;
 394 }
 395
 396 static int copy_file_with_version_check(const char *from, const char *to, bool force) {
 397         _cleanup_close_ int fd_from = -1, fd_to = -1;
 398         _cleanup_free_ char *t = NULL;
 399         int r;
 400
 401         fd_from = open(from, O_RDONLY|O_CLOEXEC|O_NOCTTY);
 402         if (fd_from < 0)
 403                 return log_error_errno(errno, "Failed to open \"%s\" for reading: %m", from);
 404
 405         if (!force) {
 406                 fd_to = open(to, O_RDONLY|O_CLOEXEC|O_NOCTTY);
 407                 if (fd_to < 0) {
 408                         if (errno != -ENOENT)
 409                                 return log_error_errno(errno, "Failed to open \"%s\" for reading: %m", to);
 410                 } else {
 411                         r = version_check(fd_from, from, fd_to, to);
 412                         if (r < 0)
 413                                 return r;
 414
 415                         if (lseek(fd_from, 0, SEEK_SET) == (off_t) -1)
 416                                 return log_error_errno(errno, "Failed to seek in \"%s\": %m", from);
 417
 418                         fd_to = safe_close(fd_to);
 419                 }
 420         }
 421
 422         r = tempfn_random(to, NULL, &t);
 423         if (r < 0)
 424                 return log_oom();
 425
 426         RUN_WITH_UMASK(0000) {
 427                 fd_to = open(t, O_WRONLY|O_CREAT|O_CLOEXEC|O_EXCL|O_NOFOLLOW, 0644);
 428                 if (fd_to < 0)
 429                         return log_error_errno(errno, "Failed to open \"%s\" for writing: %m", t);
 430         }
 431
 432         r = copy_bytes(fd_from, fd_to, (uint64_t) -1, COPY_REFLINK);
 433         if (r < 0) {
 434                 (void) unlink(t);
 435                 return log_error_errno(r, "Failed to copy data from \"%s\" to \"%s\": %m", from, t);
 436         }
 437
 438         (void) copy_times(fd_from, fd_to);
 439
 440         if (fsync(fd_to) < 0) {
 441                 (void) unlink_noerrno(t);
 442                 return log_error_errno(errno, "Failed to copy data from \"%s\" to \"%s\": %m", from, t);
 443         }
 444
 445         (void) fsync_directory_of_file(fd_to);
 446
 447         if (renameat(AT_FDCWD, t, AT_FDCWD, to) < 0) {
 448                 (void) unlink_noerrno(t);
 449                 return log_error_errno(errno, "Failed to rename \"%s\" to \"%s\": %m", t, to);
 450         }
 451
 452         log_info("Copied \"%s\" to \"%s\".", from, to);
 453
 454         return 0;
 455 }
 456
 457 static int mkdir_one(const char *prefix, const char *suffix) {
 458         char *p;
 459
 460         p = strjoina(prefix, "/", suffix);
 461         if (mkdir(p, 0700) < 0) {
 462                 if (errno != EEXIST)
 463                         return log_error_errno(errno, "Failed to create \"%s\": %m", p);
 464         } else
 465                 log_info("Created \"%s\".", p);
 466
 467         return 0;
 468 }
 469
 470 static const char *efi_subdirs[] = {
 471         "EFI",
 472         "EFI/systemd",
 473         "EFI/BOOT",
 474         "loader",
 475         "loader/entries",
 476         NULL
 477 };
 478
 479 static int create_dirs(const char *esp_path) {
 480         const char **i;
 481         int r;
 482
 483         STRV_FOREACH(i, efi_subdirs) {
 484                 r = mkdir_one(esp_path, *i);
 485                 if (r < 0)
 486                         return r;
 487         }
 488
 489         return 0;
 490 }
 491
 492 static int copy_one_file(const char *esp_path, const char *name, bool force) {
 493         char *p, *q;
 494         int r;
 495
 496         p = strjoina(BOOTLIBDIR "/", name);
 497         q = strjoina(esp_path, "/EFI/systemd/", name);
 498         r = copy_file_with_version_check(p, q, force);
 499
 500         if (startswith(name, "systemd-boot")) {
 501                 int k;
 502                 char *v;
 503
 504                 /* Create the EFI default boot loader name (specified for removable devices) */
 505                 v = strjoina(esp_path, "/EFI/BOOT/BOOT",
 506                              name + STRLEN("systemd-boot"));
 507                 ascii_strupper(strrchr(v, '/') + 1);
 508
 509                 k = copy_file_with_version_check(p, v, force);
 510                 if (k < 0 && r == 0)
 511                         r = k;
 512         }
 513
 514         return r;
 515 }
 516
 517 static int install_binaries(const char *esp_path, bool force) {
 518         struct dirent *de;
 519         _cleanup_closedir_ DIR *d = NULL;
 520         int r = 0;
 521
 522         if (force) {
 523                 /* Don't create any of these directories when we are
 524                  * just updating. When we update we'll drop-in our
 525                  * files (unless there are newer ones already), but we
 526                  * won't create the directories for them in the first
 527                  * place. */
 528                 r = create_dirs(esp_path);
 529                 if (r < 0)
 530                         return r;
 531         }
 532
 533         d = opendir(BOOTLIBDIR);
 534         if (!d)
 535                 return log_error_errno(errno, "Failed to open \""BOOTLIBDIR"\": %m");
 536
 537         FOREACH_DIRENT(de, d, break) {
 538                 int k;
 539
 540                 if (!endswith_no_case(de->d_name, ".efi"))
 541                         continue;
 542
 543                 k = copy_one_file(esp_path, de->d_name, force);
 544                 if (k < 0 && r == 0)
 545                         r = k;
 546         }
 547
 548         return r;
 549 }
 550
 551 static bool same_entry(uint16_t id, const sd_id128_t uuid, const char *path) {
 552         _cleanup_free_ char *opath = NULL;
 553         sd_id128_t ouuid;
 554         int r;
 555
 556         r = efi_get_boot_option(id, NULL, &ouuid, &opath, NULL);
 557         if (r < 0)
 558                 return false;
 559         if (!sd_id128_equal(uuid, ouuid))
 560                 return false;
 561         if (!streq_ptr(path, opath))
 562                 return false;
 563
 564         return true;
 565 }
 566
 567 static int find_slot(sd_id128_t uuid, const char *path, uint16_t *id) {
 568         _cleanup_free_ uint16_t *options = NULL;
 569         int n, i;
 570
 571         n = efi_get_boot_options(&options);
 572         if (n < 0)
 573                 return n;
 574
 575         /* find already existing systemd-boot entry */
 576         for (i = 0; i < n; i++)
 577                 if (same_entry(options[i], uuid, path)) {
 578                         *id = options[i];
 579                         return 1;
 580                 }
 581
 582         /* find free slot in the sorted BootXXXX variable list */
 583         for (i = 0; i < n; i++)
 584                 if (i != options[i]) {
 585                         *id = i;
 586                         return 1;
 587                 }
 588
 589         /* use the next one */
 590         if (i == 0xffff)
 591                 return -ENOSPC;
 592         *id = i;
 593         return 0;
 594 }
 595
 596 static int insert_into_order(uint16_t slot, bool first) {
 597         _cleanup_free_ uint16_t *order = NULL;
 598         uint16_t *t;
 599         int n, i;
 600
 601         n = efi_get_boot_order(&order);
 602         if (n <= 0)
 603                 /* no entry, add us */
 604                 return efi_set_boot_order(&slot, 1);
 605
 606         /* are we the first and only one? */
 607         if (n == 1 && order[0] == slot)
 608                 return 0;
 609
 610         /* are we already in the boot order? */
 611         for (i = 0; i < n; i++) {
 612                 if (order[i] != slot)
 613                         continue;
 614
 615                 /* we do not require to be the first one, all is fine */
 616                 if (!first)
 617                         return 0;
 618
 619                 /* move us to the first slot */
 620                 memmove(order + 1, order, i * sizeof(uint16_t));
 621                 order[0] = slot;
 622                 return efi_set_boot_order(order, n);
 623         }
 624
 625         /* extend array */
 626         t = realloc(order, (n + 1) * sizeof(uint16_t));
 627         if (!t)
 628                 return -ENOMEM;
 629         order = t;
 630
 631         /* add us to the top or end of the list */
 632         if (first) {
 633                 memmove(order + 1, order, n * sizeof(uint16_t));
 634                 order[0] = slot;
 635         } else
 636                 order[n] = slot;
 637
 638         return efi_set_boot_order(order, n + 1);
 639 }
 640
 641 static int remove_from_order(uint16_t slot) {
 642         _cleanup_free_ uint16_t *order = NULL;
 643         int n, i;
 644
 645         n = efi_get_boot_order(&order);
 646         if (n <= 0)
 647                 return n;
 648
 649         for (i = 0; i < n; i++) {
 650                 if (order[i] != slot)
 651                         continue;
 652
 653                 if (i + 1 < n)
 654                         memmove(order + i, order + i+1, (n - i) * sizeof(uint16_t));
 655                 return efi_set_boot_order(order, n - 1);
 656         }
 657
 658         return 0;
 659 }
 660
 661 static int install_variables(const char *esp_path,
 662                              uint32_t part, uint64_t pstart, uint64_t psize,
 663                              sd_id128_t uuid, const char *path,
 664                              bool first) {
 665         char *p;
 666         uint16_t slot;
 667         int r;
 668
 669         if (!is_efi_boot()) {
 670                 log_warning("Not booted with EFI, skipping EFI variable setup.");
 671                 return 0;
 672         }
 673
 674         p = strjoina(esp_path, path);
 675         if (access(p, F_OK) < 0) {
 676                 if (errno == ENOENT)
 677                         return 0;
 678
 679                 return log_error_errno(errno, "Cannot access \"%s\": %m", p);
 680         }
 681
 682         r = find_slot(uuid, path, &slot);
 683         if (r < 0)
 684                 return log_error_errno(r,
 685                                        r == -ENOENT ?
 686                                        "Failed to access EFI variables. Is the \"efivarfs\" filesystem mounted?" :
 687                                        "Failed to determine current boot order: %m");
 688
 689         if (first || r == 0) {
 690                 r = efi_add_boot_option(slot, "Linux Boot Manager",
 691                                         part, pstart, psize,
 692                                         uuid, path);
 693                 if (r < 0)
 694                         return log_error_errno(r, "Failed to create EFI Boot variable entry: %m");
 695
 696                 log_info("Created EFI boot entry \"Linux Boot Manager\".");
 697         }
 698
 699         return insert_into_order(slot, first);
 700 }
 701
 702 static int remove_boot_efi(const char *esp_path) {
 703         char *p;
 704         _cleanup_closedir_ DIR *d = NULL;
 705         struct dirent *de;
 706         int r, c = 0;
 707
 708         p = strjoina(esp_path, "/EFI/BOOT");
 709         d = opendir(p);
 710         if (!d) {
 711                 if (errno == ENOENT)
 712                         return 0;
 713
 714                 return log_error_errno(errno, "Failed to open directory \"%s\": %m", p);
 715         }
 716
 717         FOREACH_DIRENT(de, d, break) {
 718                 _cleanup_close_ int fd = -1;
 719                 _cleanup_free_ char *v = NULL;
 720
 721                 if (!endswith_no_case(de->d_name, ".efi"))
 722                         continue;
 723
 724                 if (!startswith_no_case(de->d_name, "boot"))
 725                         continue;
 726
 727                 fd = openat(dirfd(d), de->d_name, O_RDONLY|O_CLOEXEC);
 728                 if (fd < 0)
 729                         return log_error_errno(errno, "Failed to open \"%s/%s\" for reading: %m", p, de->d_name);
 730
 731                 r = get_file_version(fd, &v);
 732                 if (r < 0)
 733                         return r;
 734                 if (r > 0 && startswith(v, "systemd-boot ")) {
 735                         r = unlinkat(dirfd(d), de->d_name, 0);
 736                         if (r < 0)
 737                                 return log_error_errno(errno, "Failed to remove \"%s/%s\": %m", p, de->d_name);
 738
 739                         log_info("Removed \"%s/%s\".", p, de->d_name);
 740                 }
 741
 742                 c++;
 743         }
 744
 745         return c;
 746 }
 747
 748 static int rmdir_one(const char *prefix, const char *suffix) {
 749         char *p;
 750
 751         p = strjoina(prefix, "/", suffix);
 752         if (rmdir(p) < 0) {
 753                 if (!IN_SET(errno, ENOENT, ENOTEMPTY))
 754                         return log_error_errno(errno, "Failed to remove \"%s\": %m", p);
 755         } else
 756                 log_info("Removed \"%s\".", p);
 757
 758         return 0;
 759 }
 760
 761 static int remove_binaries(const char *esp_path) {
 762         char *p;
 763         int r, q;
 764         unsigned i;
 765
 766         p = strjoina(esp_path, "/EFI/systemd");
 767         r = rm_rf(p, REMOVE_ROOT|REMOVE_PHYSICAL);
 768
 769         q = remove_boot_efi(esp_path);
 770         if (q < 0 && r == 0)
 771                 r = q;
 772
 773         for (i = ELEMENTSOF(efi_subdirs)-1; i > 0; i--) {
 774                 q = rmdir_one(esp_path, efi_subdirs[i-1]);
 775                 if (q < 0 && r == 0)
 776                         r = q;
 777         }
 778
 779         return r;
 780 }
 781
 782 static int remove_variables(sd_id128_t uuid, const char *path, bool in_order) {
 783         uint16_t slot;
 784         int r;
 785
 786         if (!is_efi_boot())
 787                 return 0;
 788
 789         r = find_slot(uuid, path, &slot);
 790         if (r != 1)
 791                 return 0;
 792
 793         r = efi_remove_boot_option(slot);
 794         if (r < 0)
 795                 return r;
 796
 797         if (in_order)
 798                 return remove_from_order(slot);
 799
 800         return 0;
 801 }
 802
 803 static int install_loader_config(const char *esp_path) {
 804
 805         char machine_string[SD_ID128_STRING_MAX];
 806         _cleanup_(unlink_and_freep) char *t = NULL;
 807         _cleanup_fclose_ FILE *f = NULL;
 808         sd_id128_t machine_id;
 809         const char *p;
 810         int r, fd;
 811
 812         r = sd_id128_get_machine(&machine_id);
 813         if (r < 0)
 814                 return log_error_errno(r, "Failed to get machine id: %m");
 815
 816         p = strjoina(esp_path, "/loader/loader.conf");
 817
 818         if (access(p, F_OK) >= 0) /* Silently skip creation if the file already exists (early check) */
 819                 return 0;
 820
 821         fd = open_tmpfile_linkable(p, O_WRONLY|O_CLOEXEC, &t);
 822         if (fd < 0)
 823                 return log_error_errno(fd, "Failed to open \"%s\" for writing: %m", p);
 824
 825         f = fdopen(fd, "we");
 826         if (!f) {
 827                 safe_close(fd);
 828                 return log_oom();
 829         }
 830
 831         fprintf(f, "#timeout 3\n"
 832                    "#console-mode keep\n"
 833                    "default %s-*\n", sd_id128_to_string(machine_id, machine_string));
 834
 835         r = fflush_sync_and_check(f);
 836         if (r < 0)
 837                 return log_error_errno(r, "Failed to write \"%s\": %m", p);
 838
 839         r = link_tmpfile(fd, t, p);
 840         if (r == -EEXIST)
 841                 return 0; /* Silently skip creation if the file exists now (recheck) */
 842         if (r < 0)
 843                 return log_error_errno(r, "Failed to move \"%s\" into place: %m", p);
 844
 845         t = mfree(t);
 846
 847         return 1;
 848 }
 849
 850 static int help(int argc, char *argv[], void *userdata) {
 851         _cleanup_free_ char *link = NULL;
 852         int r;
 853
 854         r = terminal_urlify_man("bootctl", "1", &link);
 855         if (r < 0)
 856                 return log_oom();
 857
 858         printf("%s [COMMAND] [OPTIONS...]\n\n"
 859                "Install, update or remove the systemd-boot EFI boot manager.\n\n"
 860                "  -h --help          Show this help\n"
 861                "     --version       Print version\n"
 862                "     --path=PATH     Path to the EFI System Partition (ESP)\n"
 863                "  -p --print-path    Print path to the EFI partition\n"
 864                "     --no-variables  Don't touch EFI variables\n"
 865                "     --no-pager      Do not pipe output into a pager\n"
 866                "\nBoot Loader Commands:\n"
 867                "     status          Show status of installed systemd-boot and EFI variables\n"
 868                "     install         Install systemd-boot to the ESP and EFI variables\n"
 869                "     update          Update systemd-boot in the ESP and EFI variables\n"
 870                "     remove          Remove systemd-boot from the ESP and EFI variables\n"
 871                "\nBoot Loader Entries Commands:\n"
 872                "     list            List boot loader entries\n"
 873                "     set-default ID  Set default boot loader entry\n"
 874                "     set-oneshot ID  Set default boot loader entry, for next boot only\n"
 875                "\nSee the %s for details.\n"
 876                , program_invocation_short_name
 877                , link);
 878
 879         return 0;
 880 }
 881
 882 static int parse_argv(int argc, char *argv[]) {
 883         enum {
 884                 ARG_PATH = 0x100,
 885                 ARG_VERSION,
 886                 ARG_NO_VARIABLES,
 887                 ARG_NO_PAGER,
 888         };
 889
 890         static const struct option options[] = {
 891                 { "help",         no_argument,       NULL, 'h'              },
 892                 { "version",      no_argument,       NULL, ARG_VERSION      },
 893                 { "path",         required_argument, NULL, ARG_PATH         },
 894                 { "print-path",   no_argument,       NULL, 'p'              },
 895                 { "no-variables", no_argument,       NULL, ARG_NO_VARIABLES },
 896                 { "no-pager",     no_argument,       NULL, ARG_NO_PAGER     },
 897                 {}
 898         };
 899
 900         int c, r;
 901
 902         assert(argc >= 0);
 903         assert(argv);
 904
 905         while ((c = getopt_long(argc, argv, "hp", options, NULL)) >= 0)
 906                 switch (c) {
 907
 908                 case 'h':
 909                         help(0, NULL, NULL);
 910                         return 0;
 911
 912                 case ARG_VERSION:
 913                         return version();
 914
 915                 case ARG_PATH:
 916                         r = free_and_strdup(&arg_path, optarg);
 917                         if (r < 0)
 918                                 return log_oom();
 919                         break;
 920
 921                 case 'p':
 922                         arg_print_path = true;
 923                         break;
 924
 925                 case ARG_NO_VARIABLES:
 926                         arg_touch_variables = false;
 927                         break;
 928
 929                 case ARG_NO_PAGER:
 930                         arg_pager_flags |= PAGER_DISABLE;
 931                         break;
 932
 933                 case '?':
 934                         return -EINVAL;
 935
 936                 default:
 937                         assert_not_reached("Unknown option");
 938                 }
 939
 940         return 1;
 941 }
 942
 943 static void read_loader_efi_var(const char *name, char **var) {
 944         int r;
 945
 946         r = efi_get_variable_string(EFI_VENDOR_LOADER, name, var);
 947         if (r < 0 && r != -ENOENT)
 948                 log_warning_errno(r, "Failed to read EFI variable %s: %m", name);
 949 }
 950
 951 static int verb_status(int argc, char *argv[], void *userdata) {
 952
 953         sd_id128_t uuid = SD_ID128_NULL;
 954         int r, k;
 955
 956         r = acquire_esp(geteuid() != 0, NULL, NULL, NULL, &uuid);
 957
 958         if (arg_print_path) {
 959                 if (r == -EACCES) /* If we couldn't acquire the ESP path, log about access errors (which is the only
 960                                    * error the find_esp_and_warn() won't log on its own) */
 961                         return log_error_errno(r, "Failed to determine ESP: %m");
 962                 if (r < 0)
 963                         return r;
 964
 965                 puts(arg_path);
 966                 return 0;
 967         }
 968
 969         r = 0; /* If we couldn't determine the path, then don't consider that a problem from here on, just show what we
 970                 * can show */
 971
 972         (void) pager_open(arg_pager_flags);
 973
 974         if (is_efi_boot()) {
 975                 static const struct {
 976                         uint64_t flag;
 977                         const char *name;
 978                 } flags[] = {
 979                         { EFI_LOADER_FEATURE_BOOT_COUNTING,           "Boot counting"                 },
 980                         { EFI_LOADER_FEATURE_CONFIG_TIMEOUT,          "Menu timeout control"          },
 981                         { EFI_LOADER_FEATURE_CONFIG_TIMEOUT_ONE_SHOT, "One-shot menu timeout control" },
 982                         { EFI_LOADER_FEATURE_ENTRY_DEFAULT,           "Default entry control"         },
 983                         { EFI_LOADER_FEATURE_ENTRY_ONESHOT,           "One-shot entry control"        },
 984                 };
 985
 986                 _cleanup_free_ char *fw_type = NULL, *fw_info = NULL, *loader = NULL, *loader_path = NULL, *stub = NULL;
 987                 sd_id128_t loader_part_uuid = SD_ID128_NULL;
 988                 uint64_t loader_features = 0;
 989                 size_t i;
 990
 991                 read_loader_efi_var("LoaderFirmwareType", &fw_type);
 992                 read_loader_efi_var("LoaderFirmwareInfo", &fw_info);
 993                 read_loader_efi_var("LoaderInfo", &loader);
 994                 read_loader_efi_var("StubInfo", &stub);
 995                 read_loader_efi_var("LoaderImageIdentifier", &loader_path);
 996                 (void) efi_loader_get_features(&loader_features);
 997
 998                 if (loader_path)
 999                         efi_tilt_backslashes(loader_path);
1000
1001                 k = efi_loader_get_device_part_uuid(&loader_part_uuid);
1002                 if (k < 0 && k != -ENOENT)
1003                         r = log_warning_errno(k, "Failed to read EFI variable LoaderDevicePartUUID: %m");
1004
1005                 printf("System:\n");
1006                 printf("     Firmware: %s%s (%s)%s\n", ansi_highlight(), strna(fw_type), strna(fw_info), ansi_normal());
1007                 printf("  Secure Boot: %sd\n", enable_disable(is_efi_secure_boot()));
1008                 printf("   Setup Mode: %s\n", is_efi_secure_boot_setup_mode() ? "setup" : "user");
1009                 printf("\n");
1010
1011                 printf("Current Boot Loader:\n");
1012                 printf("      Product: %s%s%s\n", ansi_highlight(), strna(loader), ansi_normal());
1013
1014                 for (i = 0; i < ELEMENTSOF(flags); i++) {
1015
1016                         if (i == 0)
1017                                 printf("     Features: ");
1018                         else
1019                                 printf("               ");
1020
1021                         if (FLAGS_SET(loader_features, flags[i].flag))
1022                                 printf("%s%s%s %s\n", ansi_highlight_green(), special_glyph(CHECK_MARK), ansi_normal(), flags[i].name);
1023                         else
1024                                 printf("%s%s%s %s\n", ansi_highlight_red(), special_glyph(CROSS_MARK), ansi_normal(), flags[i].name);
1025                 }
1026
1027                 if (stub)
1028                         printf("         Stub: %s\n", stub);
1029                 if (!sd_id128_is_null(loader_part_uuid))
1030                         printf("          ESP: /dev/disk/by-partuuid/%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x\n",
1031                                SD_ID128_FORMAT_VAL(loader_part_uuid));
1032                 else
1033                         printf("          ESP: n/a\n");
1034                 printf("         File: %s%s\n", special_glyph(TREE_RIGHT), strna(loader_path));
1035                 printf("\n");
1036         } else
1037                 printf("System:\n    Not booted with EFI\n\n");
1038
1039         if (arg_path) {
1040                 k = status_binaries(arg_path, uuid);
1041                 if (k < 0)
1042                         r = k;
1043         }
1044
1045         if (is_efi_boot()) {
1046                 k = status_variables();
1047                 if (k < 0)
1048                         r = k;
1049         }
1050
1051         if (arg_path) {
1052                 k = status_entries(arg_path, uuid);
1053                 if (k < 0)
1054                         r = k;
1055         }
1056
1057         return r;
1058 }
1059
1060 static int verb_list(int argc, char *argv[], void *userdata) {
1061         _cleanup_(boot_config_free) BootConfig config = {};
1062         _cleanup_free_ char **found_by_loader = NULL;
1063         sd_id128_t uuid = SD_ID128_NULL;
1064         int r;
1065
1066         /* If we lack privileges we invoke find_esp_and_warn() in "unprivileged mode" here, which does two things: turn
1067          * off logging about access errors and turn off potentially privileged device probing. Here we're interested in
1068          * the latter but not the former, hence request the mode, and log about EACCES. */
1069
1070         r = acquire_esp(geteuid() != 0, NULL, NULL, NULL, &uuid);
1071         if (r == -EACCES) /* We really need the ESP path for this call, hence also log about access errors */
1072                 return log_error_errno(r, "Failed to determine ESP: %m");
1073         if (r < 0)
1074                 return r;
1075
1076         r = boot_entries_load_config(arg_path, &config);
1077         if (r < 0)
1078                 return r;
1079
1080         r = efi_loader_get_entries(&found_by_loader);
1081         if (r < 0 && !IN_SET(r, -ENOENT, -EOPNOTSUPP))
1082                 log_debug_errno(r, "Failed to acquire boot loader discovered entries: %m");
1083
1084         if (config.n_entries == 0)
1085                 log_info("No boot loader entries found.");
1086         else {
1087                 size_t n;
1088
1089                 (void) pager_open(arg_pager_flags);
1090
1091                 printf("Boot Loader Entries:\n");
1092
1093                 for (n = 0; n < config.n_entries; n++) {
1094                         r = boot_entry_show(config.entries + n, n == (size_t) config.default_entry);
1095                         if (r < 0)
1096                                 return r;
1097
1098                         puts("");
1099
1100                         strv_remove(found_by_loader, config.entries[n].id);
1101                 }
1102         }
1103
1104         if (!strv_isempty(found_by_loader)) {
1105                 char **i;
1106
1107                 printf("Automatic/Other Entries Found by Boot Loader:\n\n");
1108
1109                 STRV_FOREACH(i, found_by_loader)
1110                         puts(*i);
1111         }
1112
1113         return 0;
1114 }
1115
1116 static int sync_esp(void) {
1117         _cleanup_close_ int fd = -1;
1118
1119         if (!arg_path)
1120                 return 0;
1121
1122         fd = open(arg_path, O_CLOEXEC|O_DIRECTORY|O_RDONLY);
1123         if (fd < 0)
1124                 return log_error_errno(errno, "Couldn't open ESP '%s' for synchronization: %m", arg_path);
1125
1126         if (syncfs(fd) < 0)
1127                 return log_error_errno(errno, "Failed to synchronize the ESP '%s': %m", arg_path);
1128
1129         return 1;
1130 }
1131
1132 static int verb_install(int argc, char *argv[], void *userdata) {
1133
1134         sd_id128_t uuid = SD_ID128_NULL;
1135         uint64_t pstart = 0, psize = 0;
1136         uint32_t part = 0;
1137         bool install;
1138         int r;
1139
1140         r = acquire_esp(false, &part, &pstart, &psize, &uuid);
1141         if (r < 0)
1142                 return r;
1143
1144         install = streq(argv[0], "install");
1145
1146         RUN_WITH_UMASK(0002) {
1147                 r = install_binaries(arg_path, install);
1148                 if (r < 0)
1149                         return r;
1150
1151                 if (install) {
1152                         r = install_loader_config(arg_path);
1153                         if (r < 0)
1154                                 return r;
1155                 }
1156         }
1157
1158         (void) sync_esp();
1159
1160         if (arg_touch_variables)
1161                 r = install_variables(arg_path,
1162                                       part, pstart, psize, uuid,
1163                                       "/EFI/systemd/systemd-boot" EFI_MACHINE_TYPE_NAME ".efi",
1164                                       install);
1165
1166         return r;
1167 }
1168
1169 static int verb_remove(int argc, char *argv[], void *userdata) {
1170         sd_id128_t uuid = SD_ID128_NULL;
1171         int r;
1172
1173         r = acquire_esp(false, NULL, NULL, NULL, &uuid);
1174         if (r < 0)
1175                 return r;
1176
1177         r = remove_binaries(arg_path);
1178
1179         (void) sync_esp();
1180
1181         if (arg_touch_variables) {
1182                 int q;
1183
1184                 q = remove_variables(uuid, "/EFI/systemd/systemd-boot" EFI_MACHINE_TYPE_NAME ".efi", true);
1185                 if (q < 0 && r == 0)
1186                         r = q;
1187         }
1188
1189         return r;
1190 }
1191
1192 static int verb_set_default(int argc, char *argv[], void *userdata) {
1193         const char *name;
1194         int r;
1195
1196         if (!is_efi_boot())
1197                 return log_error_errno(SYNTHETIC_ERRNO(EOPNOTSUPP),
1198                                        "Not booted with UEFI.");
1199
1200         if (access("/sys/firmware/efi/efivars/LoaderInfo-4a67b082-0a4c-41cf-b6c7-440b29bb8c4f", F_OK) < 0) {
1201                 if (errno == ENOENT) {
1202                         log_error_errno(errno, "Not booted with a supported boot loader.");
1203                         return -EOPNOTSUPP;
1204                 }
1205
1206                 return log_error_errno(errno, "Failed to detect whether boot loader supports '%s' operation: %m", argv[0]);
1207         }
1208
1209         if (detect_container() > 0)
1210                 return log_error_errno(SYNTHETIC_ERRNO(EOPNOTSUPP),
1211                                        "'%s' operation not supported in a container.",
1212                                        argv[0]);
1213
1214         if (!arg_touch_variables)
1215                 return log_error_errno(SYNTHETIC_ERRNO(EINVAL),
1216                                        "'%s' operation cannot be combined with --touch-variables=no.",
1217                                        argv[0]);
1218
1219         name = streq(argv[0], "set-default") ? "LoaderEntryDefault" : "LoaderEntryOneShot";
1220
1221         if (isempty(argv[1])) {
1222                 r = efi_set_variable(EFI_VENDOR_LOADER, name, NULL, 0);
1223                 if (r < 0 && r != -ENOENT)
1224                         return log_error_errno(r, "Failed to remove EFI variale: %m");
1225         } else {
1226                 _cleanup_free_ char16_t *encoded = NULL;
1227
1228                 encoded = utf8_to_utf16(argv[1], strlen(argv[1]));
1229                 if (!encoded)
1230                         return log_oom();
1231
1232                 r = efi_set_variable(EFI_VENDOR_LOADER, name, encoded, char16_strlen(encoded) * 2 + 2);
1233                 if (r < 0)
1234                         return log_error_errno(r, "Failed to update EFI variable: %m");
1235         }
1236
1237         return 0;
1238 }
1239
1240 static int bootctl_main(int argc, char *argv[]) {
1241
1242         static const Verb verbs[] = {
1243                 { "help",        VERB_ANY, VERB_ANY, 0,                 help             },
1244                 { "status",      VERB_ANY, 1,        VERB_DEFAULT,      verb_status      },
1245                 { "install",     VERB_ANY, 1,        VERB_MUST_BE_ROOT, verb_install     },
1246                 { "update",      VERB_ANY, 1,        VERB_MUST_BE_ROOT, verb_install     },
1247                 { "remove",      VERB_ANY, 1,        VERB_MUST_BE_ROOT, verb_remove      },
1248                 { "list",        VERB_ANY, 1,        0,                 verb_list        },
1249                 { "set-default", 2,        2,        VERB_MUST_BE_ROOT, verb_set_default },
1250                 { "set-oneshot", 2,        2,        VERB_MUST_BE_ROOT, verb_set_default },
1251                 {}
1252         };
1253
1254         return dispatch_verb(argc, argv, verbs, NULL);
1255 }
1256
1257 static int run(int argc, char *argv[]) {
1258         int r;
1259
1260         log_parse_environment();
1261         log_open();
1262
1263         /* If we run in a container, automatically turn of EFI file system access */
1264         if (detect_container() > 0)
1265                 arg_touch_variables = false;
1266
1267         r = parse_argv(argc, argv);
1268         if (r <= 0)
1269                 return r;
1270
1271         return bootctl_main(argc, argv);
1272 }
1273
1274 DEFINE_MAIN_FUNCTION(run);