src/import/pull-tar.c

   1 /* SPDX-License-Identifier: LGPL-2.1+ */
   2 /***
   3   This file is part of systemd.
   4
   5   Copyright 2015 Lennart Poettering
   6 ***/
   7
   8 #include <curl/curl.h>
   9 #include <sys/prctl.h>
  10
  11 #include "sd-daemon.h"
  12
  13 #include "alloc-util.h"
  14 #include "btrfs-util.h"
  15 #include "copy.h"
  16 #include "curl-util.h"
  17 #include "fd-util.h"
  18 #include "fileio.h"
  19 #include "fs-util.h"
  20 #include "hostname-util.h"
  21 #include "import-common.h"
  22 #include "import-util.h"
  23 #include "macro.h"
  24 #include "mkdir.h"
  25 #include "path-util.h"
  26 #include "process-util.h"
  27 #include "pull-common.h"
  28 #include "pull-job.h"
  29 #include "pull-tar.h"
  30 #include "rm-rf.h"
  31 #include "string-util.h"
  32 #include "strv.h"
  33 #include "utf8.h"
  34 #include "util.h"
  35 #include "web-util.h"
  36
  37 typedef enum TarProgress {
  38         TAR_DOWNLOADING,
  39         TAR_VERIFYING,
  40         TAR_FINALIZING,
  41         TAR_COPYING,
  42 } TarProgress;
  43
  44 struct TarPull {
  45         sd_event *event;
  46         CurlGlue *glue;
  47
  48         char *image_root;
  49
  50         PullJob *tar_job;
  51         PullJob *settings_job;
  52         PullJob *checksum_job;
  53         PullJob *signature_job;
  54
  55         TarPullFinished on_finished;
  56         void *userdata;
  57
  58         char *local;
  59         bool force_local;
  60         bool grow_machine_directory;
  61         bool settings;
  62
  63         pid_t tar_pid;
  64
  65         char *final_path;
  66         char *temp_path;
  67
  68         char *settings_path;
  69         char *settings_temp_path;
  70
  71         ImportVerify verify;
  72 };
  73
  74 TarPull* tar_pull_unref(TarPull *i) {
  75         if (!i)
  76                 return NULL;
  77
  78         if (i->tar_pid > 1) {
  79                 (void) kill_and_sigcont(i->tar_pid, SIGKILL);
  80                 (void) wait_for_terminate(i->tar_pid, NULL);
  81         }
  82
  83         pull_job_unref(i->tar_job);
  84         pull_job_unref(i->settings_job);
  85         pull_job_unref(i->checksum_job);
  86         pull_job_unref(i->signature_job);
  87
  88         curl_glue_unref(i->glue);
  89         sd_event_unref(i->event);
  90
  91         if (i->temp_path) {
  92                 (void) rm_rf(i->temp_path, REMOVE_ROOT|REMOVE_PHYSICAL|REMOVE_SUBVOLUME);
  93                 free(i->temp_path);
  94         }
  95
  96         if (i->settings_temp_path) {
  97                 (void) unlink(i->settings_temp_path);
  98                 free(i->settings_temp_path);
  99         }
 100
 101         free(i->final_path);
 102         free(i->settings_path);
 103         free(i->image_root);
 104         free(i->local);
 105
 106         return mfree(i);
 107 }
 108
 109 int tar_pull_new(
 110                 TarPull **ret,
 111                 sd_event *event,
 112                 const char *image_root,
 113                 TarPullFinished on_finished,
 114                 void *userdata) {
 115
 116         _cleanup_(tar_pull_unrefp) TarPull *i = NULL;
 117         int r;
 118
 119         assert(ret);
 120
 121         i = new0(TarPull, 1);
 122         if (!i)
 123                 return -ENOMEM;
 124
 125         i->on_finished = on_finished;
 126         i->userdata = userdata;
 127
 128         i->image_root = strdup(image_root ?: "/var/lib/machines");
 129         if (!i->image_root)
 130                 return -ENOMEM;
 131
 132         i->grow_machine_directory = path_startswith(i->image_root, "/var/lib/machines");
 133
 134         if (event)
 135                 i->event = sd_event_ref(event);
 136         else {
 137                 r = sd_event_default(&i->event);
 138                 if (r < 0)
 139                         return r;
 140         }
 141
 142         r = curl_glue_new(&i->glue, i->event);
 143         if (r < 0)
 144                 return r;
 145
 146         i->glue->on_finished = pull_job_curl_on_finished;
 147         i->glue->userdata = i;
 148
 149         *ret = TAKE_PTR(i);
 150
 151         return 0;
 152 }
 153
 154 static void tar_pull_report_progress(TarPull *i, TarProgress p) {
 155         unsigned percent;
 156
 157         assert(i);
 158
 159         switch (p) {
 160
 161         case TAR_DOWNLOADING: {
 162                 unsigned remain = 85;
 163
 164                 percent = 0;
 165
 166                 if (i->settings_job) {
 167                         percent += i->settings_job->progress_percent * 5 / 100;
 168                         remain -= 5;
 169                 }
 170
 171                 if (i->checksum_job) {
 172                         percent += i->checksum_job->progress_percent * 5 / 100;
 173                         remain -= 5;
 174                 }
 175
 176                 if (i->signature_job) {
 177                         percent += i->signature_job->progress_percent * 5 / 100;
 178                         remain -= 5;
 179                 }
 180
 181                 if (i->tar_job)
 182                         percent += i->tar_job->progress_percent * remain / 100;
 183                 break;
 184         }
 185
 186         case TAR_VERIFYING:
 187                 percent = 85;
 188                 break;
 189
 190         case TAR_FINALIZING:
 191                 percent = 90;
 192                 break;
 193
 194         case TAR_COPYING:
 195                 percent = 95;
 196                 break;
 197
 198         default:
 199                 assert_not_reached("Unknown progress state");
 200         }
 201
 202         sd_notifyf(false, "X_IMPORT_PROGRESS=%u", percent);
 203         log_debug("Combined progress %u%%", percent);
 204 }
 205
 206 static int tar_pull_determine_path(TarPull *i, const char *suffix, char **field) {
 207         int r;
 208
 209         assert(i);
 210         assert(field);
 211
 212         if (*field)
 213                 return 0;
 214
 215         assert(i->tar_job);
 216
 217         r = pull_make_path(i->tar_job->url, i->tar_job->etag, i->image_root, ".tar-", suffix, field);
 218         if (r < 0)
 219                 return log_oom();
 220
 221         return 1;
 222 }
 223
 224 static int tar_pull_make_local_copy(TarPull *i) {
 225         int r;
 226
 227         assert(i);
 228         assert(i->tar_job);
 229
 230         if (!i->local)
 231                 return 0;
 232
 233         r = pull_make_local_copy(i->final_path, i->image_root, i->local, i->force_local);
 234         if (r < 0)
 235                 return r;
 236
 237         if (i->settings) {
 238                 const char *local_settings;
 239                 assert(i->settings_job);
 240
 241                 r = tar_pull_determine_path(i, ".nspawn", &i->settings_path);
 242                 if (r < 0)
 243                         return r;
 244
 245                 local_settings = strjoina(i->image_root, "/", i->local, ".nspawn");
 246
 247                 r = copy_file_atomic(i->settings_path, local_settings, 0664, 0, COPY_REFLINK | (i->force_local ? COPY_REPLACE : 0));
 248                 if (r == -EEXIST)
 249                         log_warning_errno(r, "Settings file %s already exists, not replacing.", local_settings);
 250                 else if (r == -ENOENT)
 251                         log_debug_errno(r, "Skipping creation of settings file, since none was found.");
 252                 else if (r < 0)
 253                         log_warning_errno(r, "Failed to copy settings files %s, ignoring: %m", local_settings);
 254                 else
 255                         log_info("Created new settings file %s.", local_settings);
 256         }
 257
 258         return 0;
 259 }
 260
 261 static bool tar_pull_is_done(TarPull *i) {
 262         assert(i);
 263         assert(i->tar_job);
 264
 265         if (!PULL_JOB_IS_COMPLETE(i->tar_job))
 266                 return false;
 267         if (i->settings_job && !PULL_JOB_IS_COMPLETE(i->settings_job))
 268                 return false;
 269         if (i->checksum_job && !PULL_JOB_IS_COMPLETE(i->checksum_job))
 270                 return false;
 271         if (i->signature_job && !PULL_JOB_IS_COMPLETE(i->signature_job))
 272                 return false;
 273
 274         return true;
 275 }
 276
 277 static void tar_pull_job_on_finished(PullJob *j) {
 278         TarPull *i;
 279         int r;
 280
 281         assert(j);
 282         assert(j->userdata);
 283
 284         i = j->userdata;
 285
 286         if (j == i->settings_job) {
 287                 if (j->error != 0)
 288                         log_info_errno(j->error, "Settings file could not be retrieved, proceeding without.");
 289         } else if (j->error != 0 && j != i->signature_job) {
 290                 if (j == i->checksum_job)
 291                         log_error_errno(j->error, "Failed to retrieve SHA256 checksum, cannot verify. (Try --verify=no?)");
 292                 else
 293                         log_error_errno(j->error, "Failed to retrieve image file. (Wrong URL?)");
 294
 295                 r = j->error;
 296                 goto finish;
 297         }
 298
 299         /* This is invoked if either the download completed
 300          * successfully, or the download was skipped because we
 301          * already have the etag. */
 302
 303         if (!tar_pull_is_done(i))
 304                 return;
 305
 306         if (i->signature_job && i->checksum_job->style == VERIFICATION_PER_DIRECTORY && i->signature_job->error != 0) {
 307                 log_error_errno(j->error, "Failed to retrieve signature file, cannot verify. (Try --verify=no?)");
 308
 309                 r = i->signature_job->error;
 310                 goto finish;
 311         }
 312
 313         i->tar_job->disk_fd = safe_close(i->tar_job->disk_fd);
 314         if (i->settings_job)
 315                 i->settings_job->disk_fd = safe_close(i->settings_job->disk_fd);
 316
 317         r = tar_pull_determine_path(i, NULL, &i->final_path);
 318         if (r < 0)
 319                 goto finish;
 320
 321         if (i->tar_pid > 0) {
 322                 r = wait_for_terminate_and_check("tar", i->tar_pid, WAIT_LOG);
 323                 i->tar_pid = 0;
 324                 if (r < 0)
 325                         goto finish;
 326                 if (r != EXIT_SUCCESS) {
 327                         r = -EIO;
 328                         goto finish;
 329                 }
 330         }
 331
 332         if (!i->tar_job->etag_exists) {
 333                 /* This is a new download, verify it, and move it into place */
 334
 335                 tar_pull_report_progress(i, TAR_VERIFYING);
 336
 337                 r = pull_verify(i->tar_job, NULL, i->settings_job, i->checksum_job, i->signature_job);
 338                 if (r < 0)
 339                         goto finish;
 340
 341                 tar_pull_report_progress(i, TAR_FINALIZING);
 342
 343                 r = import_make_read_only(i->temp_path);
 344                 if (r < 0)
 345                         goto finish;
 346
 347                 r = rename_noreplace(AT_FDCWD, i->temp_path, AT_FDCWD, i->final_path);
 348                 if (r < 0) {
 349                         log_error_errno(r, "Failed to rename to final image name to %s: %m", i->final_path);
 350                         goto finish;
 351                 }
 352
 353                 i->temp_path = mfree(i->temp_path);
 354
 355                 if (i->settings_job &&
 356                     i->settings_job->error == 0) {
 357
 358                         /* Also move the settings file into place, if it exists. Note that we do so only if we also
 359                          * moved the tar file in place, to keep things strictly in sync. */
 360                         assert(i->settings_temp_path);
 361
 362                         /* Regenerate final name for this auxiliary file, we might know the etag of the file now, and
 363                          * we should incorporate it in the file name if we can */
 364                         i->settings_path = mfree(i->settings_path);
 365
 366                         r = tar_pull_determine_path(i, ".nspawn", &i->settings_path);
 367                         if (r < 0)
 368                                 goto finish;
 369
 370                         r = import_make_read_only(i->settings_temp_path);
 371                         if (r < 0)
 372                                 goto finish;
 373
 374                         r = rename_noreplace(AT_FDCWD, i->settings_temp_path, AT_FDCWD, i->settings_path);
 375                         if (r < 0) {
 376                                 log_error_errno(r, "Failed to rename settings file to %s: %m", i->settings_path);
 377                                 goto finish;
 378                         }
 379
 380                         i->settings_temp_path = mfree(i->settings_temp_path);
 381                 }
 382         }
 383
 384         tar_pull_report_progress(i, TAR_COPYING);
 385
 386         r = tar_pull_make_local_copy(i);
 387         if (r < 0)
 388                 goto finish;
 389
 390         r = 0;
 391
 392 finish:
 393         if (i->on_finished)
 394                 i->on_finished(i, r, i->userdata);
 395         else
 396                 sd_event_exit(i->event, r);
 397 }
 398
 399 static int tar_pull_job_on_open_disk_tar(PullJob *j) {
 400         TarPull *i;
 401         int r;
 402
 403         assert(j);
 404         assert(j->userdata);
 405
 406         i = j->userdata;
 407         assert(i->tar_job == j);
 408         assert(i->tar_pid <= 0);
 409
 410         if (!i->temp_path) {
 411                 r = tempfn_random_child(i->image_root, "tar", &i->temp_path);
 412                 if (r < 0)
 413                         return log_oom();
 414         }
 415
 416         mkdir_parents_label(i->temp_path, 0700);
 417
 418         r = btrfs_subvol_make(i->temp_path);
 419         if (r == -ENOTTY) {
 420                 if (mkdir(i->temp_path, 0755) < 0)
 421                         return log_error_errno(errno, "Failed to create directory %s: %m", i->temp_path);
 422         } else if (r < 0)
 423                 return log_error_errno(r, "Failed to create subvolume %s: %m", i->temp_path);
 424         else
 425                 (void) import_assign_pool_quota_and_warn(i->temp_path);
 426
 427         j->disk_fd = import_fork_tar_x(i->temp_path, &i->tar_pid);
 428         if (j->disk_fd < 0)
 429                 return j->disk_fd;
 430
 431         return 0;
 432 }
 433
 434 static int tar_pull_job_on_open_disk_settings(PullJob *j) {
 435         TarPull *i;
 436         int r;
 437
 438         assert(j);
 439         assert(j->userdata);
 440
 441         i = j->userdata;
 442         assert(i->settings_job == j);
 443
 444         if (!i->settings_temp_path) {
 445                 r = tempfn_random_child(i->image_root, "settings", &i->settings_temp_path);
 446                 if (r < 0)
 447                         return log_oom();
 448         }
 449
 450         mkdir_parents_label(i->settings_temp_path, 0700);
 451
 452         j->disk_fd = open(i->settings_temp_path, O_RDWR|O_CREAT|O_EXCL|O_NOCTTY|O_CLOEXEC, 0664);
 453         if (j->disk_fd < 0)
 454                 return log_error_errno(errno, "Failed to create %s: %m", i->settings_temp_path);
 455
 456         return 0;
 457 }
 458
 459 static void tar_pull_job_on_progress(PullJob *j) {
 460         TarPull *i;
 461
 462         assert(j);
 463         assert(j->userdata);
 464
 465         i = j->userdata;
 466
 467         tar_pull_report_progress(i, TAR_DOWNLOADING);
 468 }
 469
 470 int tar_pull_start(
 471                 TarPull *i,
 472                 const char *url,
 473                 const char *local,
 474                 bool force_local,
 475                 ImportVerify verify,
 476                 bool settings) {
 477
 478         int r;
 479
 480         assert(i);
 481         assert(verify < _IMPORT_VERIFY_MAX);
 482         assert(verify >= 0);
 483
 484         if (!http_url_is_valid(url))
 485                 return -EINVAL;
 486
 487         if (local && !machine_name_is_valid(local))
 488                 return -EINVAL;
 489
 490         if (i->tar_job)
 491                 return -EBUSY;
 492
 493         r = free_and_strdup(&i->local, local);
 494         if (r < 0)
 495                 return r;
 496
 497         i->force_local = force_local;
 498         i->verify = verify;
 499         i->settings = settings;
 500
 501         /* Set up download job for TAR file */
 502         r = pull_job_new(&i->tar_job, url, i->glue, i);
 503         if (r < 0)
 504                 return r;
 505
 506         i->tar_job->on_finished = tar_pull_job_on_finished;
 507         i->tar_job->on_open_disk = tar_pull_job_on_open_disk_tar;
 508         i->tar_job->on_progress = tar_pull_job_on_progress;
 509         i->tar_job->calc_checksum = verify != IMPORT_VERIFY_NO;
 510         i->tar_job->grow_machine_directory = i->grow_machine_directory;
 511
 512         r = pull_find_old_etags(url, i->image_root, DT_DIR, ".tar-", NULL, &i->tar_job->old_etags);
 513         if (r < 0)
 514                 return r;
 515
 516         /* Set up download job for the settings file (.nspawn) */
 517         if (settings) {
 518                 r = pull_make_auxiliary_job(&i->settings_job, url, tar_strip_suffixes, ".nspawn", i->glue, tar_pull_job_on_finished, i);
 519                 if (r < 0)
 520                         return r;
 521
 522                 i->settings_job->on_open_disk = tar_pull_job_on_open_disk_settings;
 523                 i->settings_job->on_progress = tar_pull_job_on_progress;
 524                 i->settings_job->calc_checksum = verify != IMPORT_VERIFY_NO;
 525         }
 526
 527         /* Set up download of checksum/signature files */
 528         r = pull_make_verification_jobs(&i->checksum_job, &i->signature_job, verify, url, i->glue, tar_pull_job_on_finished, i);
 529         if (r < 0)
 530                 return r;
 531
 532         r = pull_job_begin(i->tar_job);
 533         if (r < 0)
 534                 return r;
 535
 536         if (i->settings_job) {
 537                 r = pull_job_begin(i->settings_job);
 538                 if (r < 0)
 539                         return r;
 540         }
 541
 542         if (i->checksum_job) {
 543                 i->checksum_job->on_progress = tar_pull_job_on_progress;
 544                 i->checksum_job->style = VERIFICATION_PER_FILE;
 545
 546                 r = pull_job_begin(i->checksum_job);
 547                 if (r < 0)
 548                         return r;
 549         }
 550
 551         if (i->signature_job) {
 552                 i->signature_job->on_progress = tar_pull_job_on_progress;
 553
 554                 r = pull_job_begin(i->signature_job);
 555                 if (r < 0)
 556                         return r;
 557         }
 558
 559         return 0;
 560 }