19200508431

Committed 08 Nov 2025 07:53PM UTC coverage: 72.411% (+0.3%) from 72.098%

Build # 19200508431

Build Type

push

github

Committed by

yuwata

Commit Message

README: align features after 'for'

Run Details

307177 of 424213 relevant lines covered (72.41%)

1185389.63 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

66.78

/src/import/pull.c

/* SPDX-License-Identifier: LGPL-2.1-or-later */

#include <getopt.h>
#include <locale.h>
#include <stdio.h>

#include "sd-event.h"

#include "alloc-util.h"
#include "ansi-color.h"
#include "build.h"
#include "discover-image.h"
#include "env-util.h"
#include "hexdecoct.h"
#include "import-common.h"
#include "import-util.h"
#include "io-util.h"
#include "iovec-util.h"
#include "log.h"
#include "main-func.h"
#include "parse-argument.h"
#include "parse-util.h"
#include "path-util.h"
#include "pull-raw.h"
#include "pull-tar.h"
#include "runtime-scope.h"
#include "signal-util.h"
#include "string-util.h"
#include "verbs.h"
#include "web-util.h"

static char *arg_image_root = NULL;
static ImportVerify arg_verify = IMPORT_VERIFY_SIGNATURE;
static ImportFlags arg_import_flags = IMPORT_PULL_SETTINGS | IMPORT_PULL_ROOTHASH | IMPORT_PULL_ROOTHASH_SIGNATURE | IMPORT_PULL_VERITY | IMPORT_BTRFS_SUBVOL | IMPORT_BTRFS_QUOTA | IMPORT_CONVERT_QCOW2 | IMPORT_SYNC;
static uint64_t arg_offset = UINT64_MAX, arg_size_max = UINT64_MAX;
static struct iovec arg_checksum = {};
static ImageClass arg_class = IMAGE_MACHINE;
static RuntimeScope arg_runtime_scope = _RUNTIME_SCOPE_INVALID;

STATIC_DESTRUCTOR_REGISTER(arg_checksum, iovec_done);
STATIC_DESTRUCTOR_REGISTER(arg_image_root, freep);

static int normalize_local(const char *local, const char *url, char **ret) {
        _cleanup_free_ char *ll = NULL;
        int r;

        if (arg_import_flags & IMPORT_DIRECT) {

                if (!local)
                        log_debug("Writing downloaded data to STDOUT.");
                else {
                        if (!path_is_absolute(local)) {
                                ll = path_join(arg_image_root, local);
                                if (!ll)
                                        return log_oom();

                                local = ll;
                        }

                        if (!path_is_valid(local))
                                return log_error_errno(SYNTHETIC_ERRNO(EINVAL),
                                               "Local path name '%s' is not valid.", local);
                }

        } else if (local) {

                if (!image_name_is_valid(local))
                        return log_error_errno(SYNTHETIC_ERRNO(EINVAL),
                                               "Local image name '%s' is not valid.",
                                               local);

                if (!FLAGS_SET(arg_import_flags, IMPORT_FORCE)) {
                        r = image_find(arg_runtime_scope, arg_class, local, NULL, NULL);
                        if (r < 0) {
                                if (r != -ENOENT)
                                        return log_error_errno(r, "Failed to check whether image '%s' exists: %m", local);
                        } else
                                return log_error_errno(SYNTHETIC_ERRNO(EEXIST),
                                                       "Image '%s' already exists.",
                                                       local);
                }
        }

        if (!ll && local) {
                ll = strdup(local);
                if (!ll)
                        return log_oom();
        }

        if (ll) {
                if (arg_offset != UINT64_MAX)
                        log_info("Pulling '%s', saving at offset %" PRIu64 " in '%s'.", url, arg_offset, ll);
                else
                        log_info("Pulling '%s', saving as '%s'.", url, ll);
        } else
                log_info("Pulling '%s'.", url);

        if (!FLAGS_SET(arg_import_flags, IMPORT_DIRECT))
                log_info("Operating on image directory '%s'.", arg_image_root);

        if (!FLAGS_SET(arg_import_flags, IMPORT_SYNC))
                log_info("File system synchronization on completion is off.");

        *ret = TAKE_PTR(ll);
        return 0;
}

static void on_tar_finished(TarPull *pull, int error, void *userdata) {
        sd_event *event = userdata;
        assert(pull);

        if (error == 0)
                log_info("Operation completed successfully.");

        sd_event_exit(event, ABS(error));
}

static int pull_tar(int argc, char *argv[], void *userdata) {
        _cleanup_free_ char *ll = NULL, *normalized = NULL;
        _cleanup_(sd_event_unrefp) sd_event *event = NULL;
        _cleanup_(tar_pull_unrefp) TarPull *pull = NULL;
        const char *url, *local;
        int r;

        url = argv[1];
        if (!http_url_is_valid(url) && !file_url_is_valid(url))
                return log_error_errno(SYNTHETIC_ERRNO(EINVAL), "URL '%s' is not valid.", url);

        if (argc >= 3)
                local = empty_or_dash_to_null(argv[2]);
        else {
                _cleanup_free_ char *l = NULL;

                r = import_url_last_component(url, &l);
                if (r < 0)
                        return log_error_errno(r, "Failed to get final component of URL: %m");

                r = tar_strip_suffixes(l, &ll);
                if (r < 0)
                        return log_oom();

                local = ll;
        }

        if (!local && FLAGS_SET(arg_import_flags, IMPORT_DIRECT))
                return log_error_errno(SYNTHETIC_ERRNO(EINVAL), "Pulling tar images to STDOUT is not supported.");

        r = normalize_local(local, url, &normalized);
        if (r < 0)
                return r;

        r = import_allocate_event_with_signals(&event);
        if (r < 0)
                return r;

        r = tar_pull_new(&pull, event, arg_image_root, on_tar_finished, event);
        if (r < 0)
                return log_error_errno(r, "Failed to allocate puller: %m");

        r = tar_pull_start(
                        pull,
                        url,
                        normalized,
                        arg_import_flags & IMPORT_PULL_FLAGS_MASK_TAR,
                        arg_verify,
                        &arg_checksum);
        if (r < 0)
                return log_error_errno(r, "Failed to pull image: %m");

        r = sd_event_loop(event);
        if (r < 0)
                return log_error_errno(r, "Failed to run event loop: %m");

        log_info("Exiting.");
        return -r;
}

static void on_raw_finished(RawPull *pull, int error, void *userdata) {
        sd_event *event = userdata;
        assert(pull);

        if (error == 0)
                log_info("Operation completed successfully.");

        sd_event_exit(event, ABS(error));
}

static int pull_raw(int argc, char *argv[], void *userdata) {
        _cleanup_free_ char *ll = NULL, *normalized = NULL;
        _cleanup_(sd_event_unrefp) sd_event *event = NULL;
        _cleanup_(raw_pull_unrefp) RawPull *pull = NULL;
        const char *url, *local;
        int r;

        url = argv[1];
        if (!http_url_is_valid(url) && !file_url_is_valid(url))
                return log_error_errno(SYNTHETIC_ERRNO(EINVAL), "URL '%s' is not valid.", url);

        if (argc >= 3)
                local = empty_or_dash_to_null(argv[2]);
        else {
                _cleanup_free_ char *l = NULL;

                r = import_url_last_component(url, &l);
                if (r < 0)
                        return log_error_errno(r, "Failed to get final component of URL: %m");

                r = raw_strip_suffixes(l, &ll);
                if (r < 0)
                        return log_oom();

                local = ll;
        }

        r = normalize_local(local, url, &normalized);
        if (r < 0)
                return r;

        r = import_allocate_event_with_signals(&event);
        if (r < 0)
                return r;

        r = raw_pull_new(&pull, event, arg_image_root, on_raw_finished, event);
        if (r < 0)
                return log_error_errno(r, "Failed to allocate puller: %m");

        r = raw_pull_start(
                        pull,
                        url,
                        normalized,
                        arg_offset,
                        arg_size_max,
                        arg_import_flags & IMPORT_PULL_FLAGS_MASK_RAW,
                        arg_verify,
                        &arg_checksum);
        if (r < 0)
                return log_error_errno(r, "Failed to pull image: %m");

        r = sd_event_loop(event);
        if (r < 0)
                return log_error_errno(r, "Failed to run event loop: %m");

        log_info("Exiting.");
        return -r;
}

static int help(int argc, char *argv[], void *userdata) {

        printf("%1$s [OPTIONS...] {COMMAND} ...\n"
               "\n%4$sDownload disk images.%5$s\n"
               "\n%2$sCommands:%3$s\n"
               "  tar URL [NAME]              Download a TAR image\n"
               "  raw URL [NAME]              Download a RAW image\n"
               "\n%2$sOptions:%3$s\n"
               "  -h --help                   Show this help\n"
               "     --version                Show package version\n"
               "     --force                  Force creation of image\n"
               "     --verify=MODE            Verify downloaded image, one of: 'no',\n"
               "                              'checksum', 'signature' or literal SHA256 hash\n"
               "     --settings=BOOL          Download settings file with image\n"
               "     --roothash=BOOL          Download root hash file with image\n"
               "     --roothash-signature=BOOL\n"
               "                              Download root hash signature file with image\n"
               "     --verity=BOOL            Download verity file with image\n"
               "     --image-root=PATH        Image root directory\n"
               "     --read-only              Create a read-only image\n"
               "     --direct                 Download directly to specified file\n"
               "     --btrfs-subvol=BOOL      Controls whether to create a btrfs subvolume\n"
               "                              instead of a directory\n"
               "     --btrfs-quota=BOOL       Controls whether to set up quota for btrfs\n"
               "                              subvolume\n"
               "     --convert-qcow2=BOOL     Controls whether to convert QCOW2 images to\n"
               "                              regular disk images\n"
               "     --sync=BOOL              Controls whether to sync() before completing\n"
               "     --offset=BYTES           Offset to seek to in destination\n"
               "     --size-max=BYTES         Maximum number of bytes to write to destination\n"
               "     --class=CLASS            Select image class (machine, sysext, confext,\n"
               "                              portable)\n"
               "     --keep-download=BOOL     Keep a copy pristine copy of the downloaded file\n"
               "                              around\n"
               "     --system                 Operate in per-system mode\n"
               "     --user                   Operate in per-user mode\n",
               program_invocation_short_name,
               ansi_underline(),
               ansi_normal(),
               ansi_highlight(),
               ansi_normal());

        return 0;
}

static int parse_argv(int argc, char *argv[]) {

        enum {
                ARG_VERSION = 0x100,
                ARG_FORCE,
                ARG_IMAGE_ROOT,
                ARG_VERIFY,
                ARG_SETTINGS,
                ARG_ROOTHASH,
                ARG_ROOTHASH_SIGNATURE,
                ARG_VERITY,
                ARG_READ_ONLY,
                ARG_DIRECT,
                ARG_BTRFS_SUBVOL,
                ARG_BTRFS_QUOTA,
                ARG_CONVERT_QCOW2,
                ARG_SYNC,
                ARG_OFFSET,
                ARG_SIZE_MAX,
                ARG_CLASS,
                ARG_KEEP_DOWNLOAD,
                ARG_SYSTEM,
                ARG_USER,
        };

        static const struct option options[] = {
                { "help",               no_argument,       NULL, 'h'                    },
                { "version",            no_argument,       NULL, ARG_VERSION            },
                { "force",              no_argument,       NULL, ARG_FORCE              },
                { "image-root",         required_argument, NULL, ARG_IMAGE_ROOT         },
                { "verify",             required_argument, NULL, ARG_VERIFY             },
                { "settings",           required_argument, NULL, ARG_SETTINGS           },
                { "roothash",           required_argument, NULL, ARG_ROOTHASH           },
                { "roothash-signature", required_argument, NULL, ARG_ROOTHASH_SIGNATURE },
                { "verity",             required_argument, NULL, ARG_VERITY             },
                { "read-only",          no_argument,       NULL, ARG_READ_ONLY          },
                { "direct",             no_argument,       NULL, ARG_DIRECT             },
                { "btrfs-subvol",       required_argument, NULL, ARG_BTRFS_SUBVOL       },
                { "btrfs-quota",        required_argument, NULL, ARG_BTRFS_QUOTA        },
                { "convert-qcow2",      required_argument, NULL, ARG_CONVERT_QCOW2      },
                { "sync",               required_argument, NULL, ARG_SYNC               },
                { "offset",             required_argument, NULL, ARG_OFFSET             },
                { "size-max",           required_argument, NULL, ARG_SIZE_MAX           },
                { "class",              required_argument, NULL, ARG_CLASS              },
                { "keep-download",      required_argument, NULL, ARG_KEEP_DOWNLOAD      },
                { "system",             no_argument,       NULL, ARG_SYSTEM             },
                { "user",               no_argument,       NULL, ARG_USER               },
                {}
        };

        int c, r;
        bool auto_settings = true, auto_keep_download = true;

        assert(argc >= 0);
        assert(argv);

        while ((c = getopt_long(argc, argv, "h", options, NULL)) >= 0)

                switch (c) {

                case 'h':
                        return help(0, NULL, NULL);

                case ARG_VERSION:
                        return version();

                case ARG_FORCE:
                        arg_import_flags |= IMPORT_FORCE;
                        break;

                case ARG_IMAGE_ROOT:
                        r = parse_path_argument(optarg, /* suppress_root= */ false, &arg_image_root);
                        if (r < 0)
                                return r;

                        break;

                case ARG_VERIFY: {
                        ImportVerify v;

                        v = import_verify_from_string(optarg);
                        if (v < 0) {
                                _cleanup_free_ void *h = NULL;
                                size_t n;

                                /* If this is not a valid verification mode, maybe it's a literally specified
                                 * SHA256 hash? We can handle that too... */

                                r = unhexmem(optarg, &h, &n);
                                if (r < 0 || n == 0)
                                        return log_error_errno(SYNTHETIC_ERRNO(EINVAL),
                                                               "Invalid verification setting: %s", optarg);
                                if (n != 32)
                                        return log_error_errno(SYNTHETIC_ERRNO(EINVAL),
                                                               "64 hex character SHA256 hash required when specifying explicit checksum, %zu specified", n * 2);

                                iovec_done(&arg_checksum);
                                arg_checksum.iov_base = TAKE_PTR(h);
                                arg_checksum.iov_len = n;

                                arg_import_flags &= ~(IMPORT_PULL_SETTINGS|IMPORT_PULL_ROOTHASH|IMPORT_PULL_ROOTHASH_SIGNATURE|IMPORT_PULL_VERITY);
                                arg_verify = _IMPORT_VERIFY_INVALID;
                        } else
                                arg_verify = v;

                        break;
                }

                case ARG_SETTINGS:
                        r = parse_boolean_argument("--settings=", optarg, NULL);
                        if (r < 0)
                                return r;

                        SET_FLAG(arg_import_flags, IMPORT_PULL_SETTINGS, r);
                        auto_settings = false;
                        break;

                case ARG_ROOTHASH:
                        r = parse_boolean_argument("--roothash=", optarg, NULL);
                        if (r < 0)
                                return r;

                        SET_FLAG(arg_import_flags, IMPORT_PULL_ROOTHASH, r);

                        /* If we were asked to turn off the root hash, implicitly also turn off the root hash signature */
                        if (!r)
                                SET_FLAG(arg_import_flags, IMPORT_PULL_ROOTHASH_SIGNATURE, false);
                        break;

                case ARG_ROOTHASH_SIGNATURE:
                        r = parse_boolean_argument("--roothash-signature=", optarg, NULL);
                        if (r < 0)
                                return r;

                        SET_FLAG(arg_import_flags, IMPORT_PULL_ROOTHASH_SIGNATURE, r);
                        break;

                case ARG_VERITY:
                        r = parse_boolean_argument("--verity=", optarg, NULL);
                        if (r < 0)
                                return r;

                        SET_FLAG(arg_import_flags, IMPORT_PULL_VERITY, r);
                        break;

                case ARG_READ_ONLY:
                        arg_import_flags |= IMPORT_READ_ONLY;
                        break;

                case ARG_DIRECT:
                        arg_import_flags |= IMPORT_DIRECT;
                        arg_import_flags &= ~(IMPORT_PULL_SETTINGS|IMPORT_PULL_ROOTHASH|IMPORT_PULL_ROOTHASH_SIGNATURE|IMPORT_PULL_VERITY);
                        break;

                case ARG_BTRFS_SUBVOL:
                        r = parse_boolean_argument("--btrfs-subvol=", optarg, NULL);
                        if (r < 0)
                                return r;

                        SET_FLAG(arg_import_flags, IMPORT_BTRFS_SUBVOL, r);
                        break;

                case ARG_BTRFS_QUOTA:
                        r = parse_boolean_argument("--btrfs-quota=", optarg, NULL);
                        if (r < 0)
                                return r;

                        SET_FLAG(arg_import_flags, IMPORT_BTRFS_QUOTA, r);
                        break;

                case ARG_CONVERT_QCOW2:
                        r = parse_boolean_argument("--convert-qcow2=", optarg, NULL);
                        if (r < 0)
                                return r;

                        SET_FLAG(arg_import_flags, IMPORT_CONVERT_QCOW2, r);
                        break;

                case ARG_SYNC:
                        r = parse_boolean_argument("--sync=", optarg, NULL);
                        if (r < 0)
                                return r;

                        SET_FLAG(arg_import_flags, IMPORT_SYNC, r);
                        break;

                case ARG_OFFSET: {
                        uint64_t u;

                        r = safe_atou64(optarg, &u);
                        if (r < 0)
                                return log_error_errno(r, "Failed to parse --offset= argument: %s", optarg);
                        if (!FILE_SIZE_VALID(u))
                                return log_error_errno(SYNTHETIC_ERRNO(EINVAL), "Argument to --offset= switch too large: %s", optarg);

                        arg_offset = u;
                        break;
                }

                case ARG_SIZE_MAX: {
                        uint64_t u;

                        r = parse_size(optarg, 1024, &u);
                        if (r < 0)
                                return log_error_errno(r, "Failed to parse --size-max= argument: %s", optarg);
                        if (!FILE_SIZE_VALID(u))
                                return log_error_errno(SYNTHETIC_ERRNO(EINVAL), "Argument to --size-max= switch too large: %s", optarg);

                        arg_size_max = u;
                        break;
                }

                case ARG_CLASS:
                        arg_class = image_class_from_string(optarg);
                        if (arg_class < 0)
                                return log_error_errno(arg_class, "Failed to parse --class= argument: %s", optarg);

                        break;

                case ARG_KEEP_DOWNLOAD:
                        r = parse_boolean(optarg);
                        if (r < 0)
                                return log_error_errno(r, "Failed to parse --keep-download= argument: %s", optarg);

                        SET_FLAG(arg_import_flags, IMPORT_PULL_KEEP_DOWNLOAD, r);
                        auto_keep_download = false;
                        break;

                case ARG_SYSTEM:
                        arg_runtime_scope = RUNTIME_SCOPE_SYSTEM;
                        break;

                case ARG_USER:
                        arg_runtime_scope = RUNTIME_SCOPE_USER;
                        break;

                case '?':
                        return -EINVAL;

                default:
                        assert_not_reached();
                }

        /* Make sure offset+size is still in the valid range if both set */
        if (arg_offset != UINT64_MAX && arg_size_max != UINT64_MAX &&
            ((arg_size_max > (UINT64_MAX - arg_offset)) ||
             !FILE_SIZE_VALID(arg_offset + arg_size_max)))
                return log_error_errno(SYNTHETIC_ERRNO(EINVAL), "File offset und maximum size out of range.");

        if (arg_offset != UINT64_MAX && !FLAGS_SET(arg_import_flags, IMPORT_DIRECT))
                return log_error_errno(SYNTHETIC_ERRNO(EINVAL), "File offset only supported in --direct mode.");

        if (iovec_is_set(&arg_checksum) && (arg_import_flags & (IMPORT_PULL_SETTINGS|IMPORT_PULL_ROOTHASH|IMPORT_PULL_ROOTHASH_SIGNATURE|IMPORT_PULL_VERITY)) != 0)
                return log_error_errno(SYNTHETIC_ERRNO(EINVAL), "Literal checksum verification only supported if no associated files are downloaded.");

        if (!arg_image_root) {
                r = image_root_pick(arg_runtime_scope < 0 ? RUNTIME_SCOPE_SYSTEM : arg_runtime_scope, arg_class, /* runtime= */ false, &arg_image_root);
                if (r < 0)
                        return log_error_errno(r, "Failed to pick image root: %m");
        }

        /* .nspawn settings files only really make sense for machine images, not for sysext/confext/portable */
        if (auto_settings && arg_class != IMAGE_MACHINE)
                arg_import_flags &= ~IMPORT_PULL_SETTINGS;

        /* Keep the original pristine downloaded file as a copy only when dealing with machine images,
         * because unlike sysext/confext/portable they are typically modified during runtime. */
        if (auto_keep_download)
                SET_FLAG(arg_import_flags, IMPORT_PULL_KEEP_DOWNLOAD, arg_class == IMAGE_MACHINE);

        if (arg_runtime_scope == RUNTIME_SCOPE_USER)
                arg_import_flags |= IMPORT_FOREIGN_UID;

        return 1;
}

static void parse_env(void) {
        int r;

        /* Let's make these relatively low-level settings also controllable via env vars. User can then set
         * them for systemd-importd.service if they like to tweak behaviour */

        r = getenv_bool("SYSTEMD_IMPORT_BTRFS_SUBVOL");
        if (r >= 0)
                SET_FLAG(arg_import_flags, IMPORT_BTRFS_SUBVOL, r);
        else if (r != -ENXIO)
                log_warning_errno(r, "Failed to parse $SYSTEMD_IMPORT_BTRFS_SUBVOL: %m");

        r = getenv_bool("SYSTEMD_IMPORT_BTRFS_QUOTA");
        if (r >= 0)
                SET_FLAG(arg_import_flags, IMPORT_BTRFS_QUOTA, r);
        else if (r != -ENXIO)
                log_warning_errno(r, "Failed to parse $SYSTEMD_IMPORT_BTRFS_QUOTA: %m");

        r = getenv_bool("SYSTEMD_IMPORT_SYNC");
        if (r >= 0)
                SET_FLAG(arg_import_flags, IMPORT_SYNC, r);
        else if (r != -ENXIO)
                log_warning_errno(r, "Failed to parse $SYSTEMD_IMPORT_SYNC: %m");
}

static int pull_main(int argc, char *argv[]) {
        static const Verb verbs[] = {
                { "help", VERB_ANY, VERB_ANY, 0, help     },
                { "tar",  2,        3,        0, pull_tar },
                { "raw",  2,        3,        0, pull_raw },
                {}
        };

        return dispatch_verb(argc, argv, verbs, NULL);
}

static int run(int argc, char *argv[]) {
        int r;

        setlocale(LC_ALL, "");
        log_setup();

        parse_env();

        r = parse_argv(argc, argv);
        if (r <= 0)
                return r;

        (void) ignore_signals(SIGPIPE);

        return pull_main(argc, argv);
}

DEFINE_MAIN_FUNCTION(run);

1	/* SPDX-License-Identifier: LGPL-2.1-or-later */
2
3	#include <getopt.h>
4	#include <locale.h>
5	#include <stdio.h>
6
7	#include "sd-event.h"
8
9	#include "alloc-util.h"
10	#include "ansi-color.h"
11	#include "build.h"
12	#include "discover-image.h"
13	#include "env-util.h"
14	#include "hexdecoct.h"
15	#include "import-common.h"
16	#include "import-util.h"
17	#include "io-util.h"
18	#include "iovec-util.h"
19	#include "log.h"
20	#include "main-func.h"
21	#include "parse-argument.h"
22	#include "parse-util.h"
23	#include "path-util.h"
24	#include "pull-raw.h"
25	#include "pull-tar.h"
26	#include "runtime-scope.h"
27	#include "signal-util.h"
28	#include "string-util.h"
29	#include "verbs.h"
30	#include "web-util.h"
31
32	static char *arg_image_root = NULL;
33	static ImportVerify arg_verify = IMPORT_VERIFY_SIGNATURE;
34	static ImportFlags arg_import_flags = IMPORT_PULL_SETTINGS \| IMPORT_PULL_ROOTHASH \| IMPORT_PULL_ROOTHASH_SIGNATURE \| IMPORT_PULL_VERITY \| IMPORT_BTRFS_SUBVOL \| IMPORT_BTRFS_QUOTA \| IMPORT_CONVERT_QCOW2 \| IMPORT_SYNC;
35	static uint64_t arg_offset = UINT64_MAX, arg_size_max = UINT64_MAX;
36	static struct iovec arg_checksum = {};
37	static ImageClass arg_class = IMAGE_MACHINE;
38	static RuntimeScope arg_runtime_scope = _RUNTIME_SCOPE_INVALID;
39
40	STATIC_DESTRUCTOR_REGISTER(arg_checksum, iovec_done);	27✔
41	STATIC_DESTRUCTOR_REGISTER(arg_image_root, freep);	27✔
42
43	static int normalize_local(const char local, const char url, char **ret) {	27✔
44	_cleanup_free_ char *ll = NULL;	27✔
45	int r;	27✔
46
47	if (arg_import_flags & IMPORT_DIRECT) {	27✔
48
49	if (!local)	20✔
50	log_debug("Writing downloaded data to STDOUT.");	12✔
51	else {
52	if (!path_is_absolute(local)) {	8✔
53	ll = path_join(arg_image_root, local);	×
54	if (!ll)	×
55	return log_oom();	×
56
57	local = ll;
58	}
59
60	if (!path_is_valid(local))	8✔
61	return log_error_errno(SYNTHETIC_ERRNO(EINVAL),	×
62	"Local path name '%s' is not valid.", local);
63	}
64
65	} else if (local) {	7✔
66
67	if (!image_name_is_valid(local))	7✔
68	return log_error_errno(SYNTHETIC_ERRNO(EINVAL),	×
69	"Local image name '%s' is not valid.",
70	local);
71
72	if (!FLAGS_SET(arg_import_flags, IMPORT_FORCE)) {	7✔
73	r = image_find(arg_runtime_scope, arg_class, local, NULL, NULL);	7✔
74	if (r < 0) {	7✔
75	if (r != -ENOENT)	6✔
76	return log_error_errno(r, "Failed to check whether image '%s' exists: %m", local);	×
77	} else
78	return log_error_errno(SYNTHETIC_ERRNO(EEXIST),	1✔
79	"Image '%s' already exists.",
80	local);
81	}
82	}
83
84	if (!ll && local) {	26✔
85	ll = strdup(local);	14✔
86	if (!ll)	14✔
87	return log_oom();	×
88	}
89
90	if (ll) {	12✔
91	if (arg_offset != UINT64_MAX)	14✔
92	log_info("Pulling '%s', saving at offset %" PRIu64 " in '%s'.", url, arg_offset, ll);	4✔
93	else
94	log_info("Pulling '%s', saving as '%s'.", url, ll);	10✔
95	} else
96	log_info("Pulling '%s'.", url);	12✔
97
98	if (!FLAGS_SET(arg_import_flags, IMPORT_DIRECT))	26✔
99	log_info("Operating on image directory '%s'.", arg_image_root);	6✔
100
101	if (!FLAGS_SET(arg_import_flags, IMPORT_SYNC))	26✔
102	log_info("File system synchronization on completion is off.");	×
103
104	*ret = TAKE_PTR(ll);	26✔
105	return 0;	26✔
106	}
107
108	static void on_tar_finished(TarPull pull, int error, void userdata) {	9✔
109	sd_event *event = userdata;	9✔
110	assert(pull);	9✔
111
112	if (error == 0)	9✔
113	log_info("Operation completed successfully.");	8✔
114
115	sd_event_exit(event, ABS(error));	9✔
116	}	9✔
117
118	static int pull_tar(int argc, char argv[], void userdata) {	9✔
119	_cleanup_free_ char ll = NULL, normalized = NULL;	9✔
120	_cleanup_(sd_event_unrefp) sd_event *event = NULL;	9✔
121	_cleanup_(tar_pull_unrefp) TarPull *pull = NULL;	9✔
122	const char url, local;	9✔
123	int r;	9✔
124
125	url = argv[1];	9✔
126	if (!http_url_is_valid(url) && !file_url_is_valid(url))	9✔
127	return log_error_errno(SYNTHETIC_ERRNO(EINVAL), "URL '%s' is not valid.", url);	×
128
129	if (argc >= 3)	9✔
130	local = empty_or_dash_to_null(argv[2]);	9✔
131	else {
132	_cleanup_free_ char *l = NULL;	×
133
134	r = import_url_last_component(url, &l);	×
135	if (r < 0)	×
136	return log_error_errno(r, "Failed to get final component of URL: %m");	×
137
138	r = tar_strip_suffixes(l, &ll);	×
139	if (r < 0)	×
140	return log_oom();	×
141
142	local = ll;	×
143	}
144
145	if (!local && FLAGS_SET(arg_import_flags, IMPORT_DIRECT))	9✔
146	return log_error_errno(SYNTHETIC_ERRNO(EINVAL), "Pulling tar images to STDOUT is not supported.");	×
147
148	r = normalize_local(local, url, &normalized);	9✔
149	if (r < 0)	9✔
150	return r;
151
152	r = import_allocate_event_with_signals(&event);	9✔
153	if (r < 0)	9✔
154	return r;
155
156	r = tar_pull_new(&pull, event, arg_image_root, on_tar_finished, event);	9✔
157	if (r < 0)	9✔
158	return log_error_errno(r, "Failed to allocate puller: %m");	×
159
160	r = tar_pull_start(	18✔
161	pull,
162	url,
163	normalized,
164	arg_import_flags & IMPORT_PULL_FLAGS_MASK_TAR,	9✔
165	arg_verify,
166	&arg_checksum);
167	if (r < 0)	9✔
168	return log_error_errno(r, "Failed to pull image: %m");	×
169
170	r = sd_event_loop(event);	9✔
171	if (r < 0)	9✔
172	return log_error_errno(r, "Failed to run event loop: %m");	×
173
174	log_info("Exiting.");	9✔
175	return -r;	9✔
176	}
177
178	static void on_raw_finished(RawPull pull, int error, void userdata) {	17✔
179	sd_event *event = userdata;	17✔
180	assert(pull);	17✔
181
182	if (error == 0)	17✔
183	log_info("Operation completed successfully.");	17✔
184
185	sd_event_exit(event, ABS(error));	17✔
186	}	17✔
187
188	static int pull_raw(int argc, char argv[], void userdata) {	18✔
189	_cleanup_free_ char ll = NULL, normalized = NULL;	18✔
190	_cleanup_(sd_event_unrefp) sd_event *event = NULL;	18✔
191	_cleanup_(raw_pull_unrefp) RawPull *pull = NULL;	18✔
192	const char url, local;	18✔
193	int r;	18✔
194
195	url = argv[1];	18✔
196	if (!http_url_is_valid(url) && !file_url_is_valid(url))	18✔
197	return log_error_errno(SYNTHETIC_ERRNO(EINVAL), "URL '%s' is not valid.", url);	×
198
199	if (argc >= 3)	18✔
200	local = empty_or_dash_to_null(argv[2]);	30✔
201	else {
202	_cleanup_free_ char *l = NULL;	×
203
204	r = import_url_last_component(url, &l);	×
205	if (r < 0)	×
206	return log_error_errno(r, "Failed to get final component of URL: %m");	×
207
208	r = raw_strip_suffixes(l, &ll);	×
209	if (r < 0)	×
210	return log_oom();	×
211
212	local = ll;	×
213	}
214
215	r = normalize_local(local, url, &normalized);	18✔
216	if (r < 0)	18✔
217	return r;
218
219	r = import_allocate_event_with_signals(&event);	17✔
220	if (r < 0)	17✔
221	return r;
222
223	r = raw_pull_new(&pull, event, arg_image_root, on_raw_finished, event);	17✔
224	if (r < 0)	17✔
225	return log_error_errno(r, "Failed to allocate puller: %m");	×
226
227	r = raw_pull_start(	34✔
228	pull,
229	url,
230	normalized,
231	arg_offset,
232	arg_size_max,
233	arg_import_flags & IMPORT_PULL_FLAGS_MASK_RAW,	17✔
234	arg_verify,
235	&arg_checksum);
236	if (r < 0)	17✔
237	return log_error_errno(r, "Failed to pull image: %m");	×
238
239	r = sd_event_loop(event);	17✔
240	if (r < 0)	17✔
241	return log_error_errno(r, "Failed to run event loop: %m");	×
242
243	log_info("Exiting.");	17✔
244	return -r;	17✔
245	}
246
247	static int help(int argc, char argv[], void userdata) {	×
248
249	printf("%1$s [OPTIONS...] {COMMAND} ...\n"	×
250	"\n%4$sDownload disk images.%5$s\n"
251	"\n%2$sCommands:%3$s\n"
252	" tar URL [NAME] Download a TAR image\n"
253	" raw URL [NAME] Download a RAW image\n"
254	"\n%2$sOptions:%3$s\n"
255	" -h --help Show this help\n"
256	" --version Show package version\n"
257	" --force Force creation of image\n"
258	" --verify=MODE Verify downloaded image, one of: 'no',\n"
259	" 'checksum', 'signature' or literal SHA256 hash\n"
260	" --settings=BOOL Download settings file with image\n"
261	" --roothash=BOOL Download root hash file with image\n"
262	" --roothash-signature=BOOL\n"
263	" Download root hash signature file with image\n"
264	" --verity=BOOL Download verity file with image\n"
265	" --image-root=PATH Image root directory\n"
266	" --read-only Create a read-only image\n"
267	" --direct Download directly to specified file\n"
268	" --btrfs-subvol=BOOL Controls whether to create a btrfs subvolume\n"
269	" instead of a directory\n"
270	" --btrfs-quota=BOOL Controls whether to set up quota for btrfs\n"
271	" subvolume\n"
272	" --convert-qcow2=BOOL Controls whether to convert QCOW2 images to\n"
273	" regular disk images\n"
274	" --sync=BOOL Controls whether to sync() before completing\n"
275	" --offset=BYTES Offset to seek to in destination\n"
276	" --size-max=BYTES Maximum number of bytes to write to destination\n"
277	" --class=CLASS Select image class (machine, sysext, confext,\n"
278	" portable)\n"
279	" --keep-download=BOOL Keep a copy pristine copy of the downloaded file\n"
280	" around\n"
281	" --system Operate in per-system mode\n"
282	" --user Operate in per-user mode\n",
283	program_invocation_short_name,
284	ansi_underline(),
285	ansi_normal(),
286	ansi_highlight(),
287	ansi_normal());
288
289	return 0;	×
290	}
291
292	static int parse_argv(int argc, char *argv[]) {	27✔
293
294	enum {	27✔
295	ARG_VERSION = 0x100,
296	ARG_FORCE,
297	ARG_IMAGE_ROOT,
298	ARG_VERIFY,
299	ARG_SETTINGS,
300	ARG_ROOTHASH,
301	ARG_ROOTHASH_SIGNATURE,
302	ARG_VERITY,
303	ARG_READ_ONLY,
304	ARG_DIRECT,
305	ARG_BTRFS_SUBVOL,
306	ARG_BTRFS_QUOTA,
307	ARG_CONVERT_QCOW2,
308	ARG_SYNC,
309	ARG_OFFSET,
310	ARG_SIZE_MAX,
311	ARG_CLASS,
312	ARG_KEEP_DOWNLOAD,
313	ARG_SYSTEM,
314	ARG_USER,
315	};
316
317	static const struct option options[] = {	27✔
318	{ "help", no_argument, NULL, 'h' },
319	{ "version", no_argument, NULL, ARG_VERSION },
320	{ "force", no_argument, NULL, ARG_FORCE },
321	{ "image-root", required_argument, NULL, ARG_IMAGE_ROOT },
322	{ "verify", required_argument, NULL, ARG_VERIFY },
323	{ "settings", required_argument, NULL, ARG_SETTINGS },
324	{ "roothash", required_argument, NULL, ARG_ROOTHASH },
325	{ "roothash-signature", required_argument, NULL, ARG_ROOTHASH_SIGNATURE },
326	{ "verity", required_argument, NULL, ARG_VERITY },
327	{ "read-only", no_argument, NULL, ARG_READ_ONLY },
328	{ "direct", no_argument, NULL, ARG_DIRECT },
329	{ "btrfs-subvol", required_argument, NULL, ARG_BTRFS_SUBVOL },
330	{ "btrfs-quota", required_argument, NULL, ARG_BTRFS_QUOTA },
331	{ "convert-qcow2", required_argument, NULL, ARG_CONVERT_QCOW2 },
332	{ "sync", required_argument, NULL, ARG_SYNC },
333	{ "offset", required_argument, NULL, ARG_OFFSET },
334	{ "size-max", required_argument, NULL, ARG_SIZE_MAX },
335	{ "class", required_argument, NULL, ARG_CLASS },
336	{ "keep-download", required_argument, NULL, ARG_KEEP_DOWNLOAD },
337	{ "system", no_argument, NULL, ARG_SYSTEM },
338	{ "user", no_argument, NULL, ARG_USER },
339	{}
340	};
341
342	int c, r;	27✔
343	bool auto_settings = true, auto_keep_download = true;	27✔
344
345	assert(argc >= 0);	27✔
346	assert(argv);	27✔
347
348	while ((c = getopt_long(argc, argv, "h", options, NULL)) >= 0)	115✔
349
350	switch (c) {	88✔
351
352	case 'h':	×
353	return help(0, NULL, NULL);	×
354
355	case ARG_VERSION:	×
356	return version();	×
357
358	case ARG_FORCE:	×
359	arg_import_flags \|= IMPORT_FORCE;	×
360	break;	×
361
362	case ARG_IMAGE_ROOT:	1✔
363	r = parse_path_argument(optarg, /* suppress_root= */ false, &arg_image_root);	1✔
364	if (r < 0)	1✔
365	return r;
366
367	break;
368
369	case ARG_VERIFY: {	27✔
370	ImportVerify v;	27✔
371
372	v = import_verify_from_string(optarg);	27✔
373	if (v < 0) {	27✔
374	_cleanup_free_ void *h = NULL;	×
375	size_t n;	8✔
376
377	/* If this is not a valid verification mode, maybe it's a literally specified
378	* SHA256 hash? We can handle that too... */
379
380	r = unhexmem(optarg, &h, &n);	8✔
381	if (r < 0 \|\| n == 0)	8✔
382	return log_error_errno(SYNTHETIC_ERRNO(EINVAL),	×
383	"Invalid verification setting: %s", optarg);
384	if (n != 32)	8✔
385	return log_error_errno(SYNTHETIC_ERRNO(EINVAL),	×
386	"64 hex character SHA256 hash required when specifying explicit checksum, %zu specified", n * 2);
387
388	iovec_done(&arg_checksum);	8✔
389	arg_checksum.iov_base = TAKE_PTR(h);	8✔
390	arg_checksum.iov_len = n;	8✔
391
392	arg_import_flags &= ~(IMPORT_PULL_SETTINGS\|IMPORT_PULL_ROOTHASH\|IMPORT_PULL_ROOTHASH_SIGNATURE\|IMPORT_PULL_VERITY);	8✔
393	arg_verify = _IMPORT_VERIFY_INVALID;	8✔
394	} else
395	arg_verify = v;	19✔
396
397	break;
398	}
399
400	case ARG_SETTINGS:	×
401	r = parse_boolean_argument("--settings=", optarg, NULL);	×
402	if (r < 0)	×
403	return r;
404
405	SET_FLAG(arg_import_flags, IMPORT_PULL_SETTINGS, r);	×
406	auto_settings = false;	×
407	break;	×
408
409	case ARG_ROOTHASH:	×
410	r = parse_boolean_argument("--roothash=", optarg, NULL);	×
411	if (r < 0)	×
412	return r;
413
414	SET_FLAG(arg_import_flags, IMPORT_PULL_ROOTHASH, r);	×
415
416	/* If we were asked to turn off the root hash, implicitly also turn off the root hash signature */
417	if (!r)	×
418	SET_FLAG(arg_import_flags, IMPORT_PULL_ROOTHASH_SIGNATURE, false);	×
419	break;
420
421	case ARG_ROOTHASH_SIGNATURE:	×
422	r = parse_boolean_argument("--roothash-signature=", optarg, NULL);	×
423	if (r < 0)	×
424	return r;
425
426	SET_FLAG(arg_import_flags, IMPORT_PULL_ROOTHASH_SIGNATURE, r);	×
427	break;	×
428
429	case ARG_VERITY:	×
430	r = parse_boolean_argument("--verity=", optarg, NULL);	×
431	if (r < 0)	×
432	return r;
433
434	SET_FLAG(arg_import_flags, IMPORT_PULL_VERITY, r);	×
435	break;	×
436
437	case ARG_READ_ONLY:	×
438	arg_import_flags \|= IMPORT_READ_ONLY;	×
439	break;	×
440
441	case ARG_DIRECT:	20✔
442	arg_import_flags \|= IMPORT_DIRECT;	20✔
443	arg_import_flags &= ~(IMPORT_PULL_SETTINGS\|IMPORT_PULL_ROOTHASH\|IMPORT_PULL_ROOTHASH_SIGNATURE\|IMPORT_PULL_VERITY);	20✔
444	break;	20✔
445
446	case ARG_BTRFS_SUBVOL:	4✔
447	r = parse_boolean_argument("--btrfs-subvol=", optarg, NULL);	4✔
448	if (r < 0)	4✔
449	return r;
450
451	SET_FLAG(arg_import_flags, IMPORT_BTRFS_SUBVOL, r);	4✔
452	break;	4✔
453
454	case ARG_BTRFS_QUOTA:	×
455	r = parse_boolean_argument("--btrfs-quota=", optarg, NULL);	×
456	if (r < 0)	×
457	return r;
458
459	SET_FLAG(arg_import_flags, IMPORT_BTRFS_QUOTA, r);	×
460	break;	×
461
462	case ARG_CONVERT_QCOW2:	×
463	r = parse_boolean_argument("--convert-qcow2=", optarg, NULL);	×
464	if (r < 0)	×
465	return r;
466
467	SET_FLAG(arg_import_flags, IMPORT_CONVERT_QCOW2, r);	×
468	break;	×
469
470	case ARG_SYNC:	8✔
471	r = parse_boolean_argument("--sync=", optarg, NULL);	8✔
472	if (r < 0)	8✔
473	return r;
474
475	SET_FLAG(arg_import_flags, IMPORT_SYNC, r);	8✔
476	break;	8✔
477
478	case ARG_OFFSET: {	4✔
479	uint64_t u;	4✔
480
481	r = safe_atou64(optarg, &u);	4✔
482	if (r < 0)	4✔
483	return log_error_errno(r, "Failed to parse --offset= argument: %s", optarg);	×
484	if (!FILE_SIZE_VALID(u))	4✔
485	return log_error_errno(SYNTHETIC_ERRNO(EINVAL), "Argument to --offset= switch too large: %s", optarg);	×
486
487	arg_offset = u;	4✔
488	break;	4✔
489	}
490
491	case ARG_SIZE_MAX: {	4✔
492	uint64_t u;	4✔
493
494	r = parse_size(optarg, 1024, &u);	4✔
495	if (r < 0)	4✔
496	return log_error_errno(r, "Failed to parse --size-max= argument: %s", optarg);	×
497	if (!FILE_SIZE_VALID(u))	4✔
498	return log_error_errno(SYNTHETIC_ERRNO(EINVAL), "Argument to --size-max= switch too large: %s", optarg);	×
499
500	arg_size_max = u;	4✔
501	break;	4✔
502	}
503
504	case ARG_CLASS:	6✔
505	arg_class = image_class_from_string(optarg);	6✔
506	if (arg_class < 0)	6✔
507	return log_error_errno(arg_class, "Failed to parse --class= argument: %s", optarg);	×
508
509	break;
510
511	case ARG_KEEP_DOWNLOAD:	7✔
512	r = parse_boolean(optarg);	7✔
513	if (r < 0)	7✔
514	return log_error_errno(r, "Failed to parse --keep-download= argument: %s", optarg);	×
515
516	SET_FLAG(arg_import_flags, IMPORT_PULL_KEEP_DOWNLOAD, r);	7✔
517	auto_keep_download = false;	7✔
518	break;	7✔
519
520	case ARG_SYSTEM:	6✔
521	arg_runtime_scope = RUNTIME_SCOPE_SYSTEM;	6✔
522	break;	6✔
523
524	case ARG_USER:	1✔
525	arg_runtime_scope = RUNTIME_SCOPE_USER;	1✔
526	break;	1✔
527
528	case '?':
529	return -EINVAL;
530
531	default:	×
532	assert_not_reached();	×
533	}
534
535	/* Make sure offset+size is still in the valid range if both set */
536	if (arg_offset != UINT64_MAX && arg_size_max != UINT64_MAX &&	27✔
537	((arg_size_max > (UINT64_MAX - arg_offset)) \|\|	4✔
538	!FILE_SIZE_VALID(arg_offset + arg_size_max)))	4✔
539	return log_error_errno(SYNTHETIC_ERRNO(EINVAL), "File offset und maximum size out of range.");	×
540
541	if (arg_offset != UINT64_MAX && !FLAGS_SET(arg_import_flags, IMPORT_DIRECT))	27✔
542	return log_error_errno(SYNTHETIC_ERRNO(EINVAL), "File offset only supported in --direct mode.");	×
543
544	if (iovec_is_set(&arg_checksum) && (arg_import_flags & (IMPORT_PULL_SETTINGS\|IMPORT_PULL_ROOTHASH\|IMPORT_PULL_ROOTHASH_SIGNATURE\|IMPORT_PULL_VERITY)) != 0)	35✔
545	return log_error_errno(SYNTHETIC_ERRNO(EINVAL), "Literal checksum verification only supported if no associated files are downloaded.");	×
546
547	if (!arg_image_root) {	27✔
548	r = image_root_pick(arg_runtime_scope < 0 ? RUNTIME_SCOPE_SYSTEM : arg_runtime_scope, arg_class, /* runtime= */ false, &arg_image_root);	26✔
549	if (r < 0)	26✔
550	return log_error_errno(r, "Failed to pick image root: %m");	×
551	}
552
553	/* .nspawn settings files only really make sense for machine images, not for sysext/confext/portable */
554	if (auto_settings && arg_class != IMAGE_MACHINE)	27✔
555	arg_import_flags &= ~IMPORT_PULL_SETTINGS;	6✔
556
557	/* Keep the original pristine downloaded file as a copy only when dealing with machine images,
558	* because unlike sysext/confext/portable they are typically modified during runtime. */
559	if (auto_keep_download)	27✔
560	SET_FLAG(arg_import_flags, IMPORT_PULL_KEEP_DOWNLOAD, arg_class == IMAGE_MACHINE);	20✔
561
562	if (arg_runtime_scope == RUNTIME_SCOPE_USER)	27✔
563	arg_import_flags \|= IMPORT_FOREIGN_UID;	1✔
564
565	return 1;
566	}
567
568	static void parse_env(void) {	27✔
569	int r;	27✔
570
571	/* Let's make these relatively low-level settings also controllable via env vars. User can then set
572	* them for systemd-importd.service if they like to tweak behaviour */
573
574	r = getenv_bool("SYSTEMD_IMPORT_BTRFS_SUBVOL");	27✔
575	if (r >= 0)	27✔
576	SET_FLAG(arg_import_flags, IMPORT_BTRFS_SUBVOL, r);	×
577	else if (r != -ENXIO)	27✔
578	log_warning_errno(r, "Failed to parse $SYSTEMD_IMPORT_BTRFS_SUBVOL: %m");	×
579
580	r = getenv_bool("SYSTEMD_IMPORT_BTRFS_QUOTA");	27✔
581	if (r >= 0)	27✔
582	SET_FLAG(arg_import_flags, IMPORT_BTRFS_QUOTA, r);	×
583	else if (r != -ENXIO)	27✔
584	log_warning_errno(r, "Failed to parse $SYSTEMD_IMPORT_BTRFS_QUOTA: %m");	×
585
586	r = getenv_bool("SYSTEMD_IMPORT_SYNC");	27✔
587	if (r >= 0)	27✔
588	SET_FLAG(arg_import_flags, IMPORT_SYNC, r);	×
589	else if (r != -ENXIO)	27✔
590	log_warning_errno(r, "Failed to parse $SYSTEMD_IMPORT_SYNC: %m");	×
591	}	27✔
592
593	static int pull_main(int argc, char *argv[]) {	27✔
594	static const Verb verbs[] = {	27✔
595	{ "help", VERB_ANY, VERB_ANY, 0, help },
596	{ "tar", 2, 3, 0, pull_tar },
597	{ "raw", 2, 3, 0, pull_raw },
598	{}
599	};
600
601	return dispatch_verb(argc, argv, verbs, NULL);	27✔
602	}
603
604	static int run(int argc, char *argv[]) {	27✔
605	int r;	27✔
606
607	setlocale(LC_ALL, "");	27✔
608	log_setup();	27✔
609
610	parse_env();	27✔
611
612	r = parse_argv(argc, argv);	27✔
613	if (r <= 0)	27✔
614	return r;
615
616	(void) ignore_signals(SIGPIPE);	27✔
617
618	return pull_main(argc, argv);	27✔
619	}
620
621	DEFINE_MAIN_FUNCTION(run);	27✔

systemd / systemd / 19200508431

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous