Debian Codegraph @

src/shared/varlink-io.systemd.Import.c

raw
1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
2
3 #include "bus-polkit.h"
4 #include "varlink-io.systemd.Import.h"
5
6 static SD_VARLINK_DEFINE_ENUM_TYPE(
7 ImageClass,
8 SD_VARLINK_FIELD_COMMENT("An image to boot as a system on baremetal, in a VM or as a container"),
9 SD_VARLINK_DEFINE_ENUM_VALUE(machine),
10 SD_VARLINK_FIELD_COMMENT("An portable service image"),
11 SD_VARLINK_DEFINE_ENUM_VALUE(portable),
12 SD_VARLINK_FIELD_COMMENT("A system extension image"),
13 SD_VARLINK_DEFINE_ENUM_VALUE(sysext),
14 SD_VARLINK_FIELD_COMMENT("A configuration extension image"),
15 SD_VARLINK_DEFINE_ENUM_VALUE(confext));
16
17 static SD_VARLINK_DEFINE_ENUM_TYPE(
18 RemoteType,
19 SD_VARLINK_FIELD_COMMENT("Raw binary disk images, typically in a GPT envelope"),
20 SD_VARLINK_DEFINE_ENUM_VALUE(raw),
21 SD_VARLINK_FIELD_COMMENT("A tarball, optionally compressed"),
22 SD_VARLINK_DEFINE_ENUM_VALUE(tar));
23
24 static SD_VARLINK_DEFINE_ENUM_TYPE(
25 TransferType,
26 SD_VARLINK_FIELD_COMMENT("A local import of a tarball"),
27 SD_VARLINK_DEFINE_ENUM_VALUE(import_tar),
28 SD_VARLINK_FIELD_COMMENT("A local import of a raw disk image"),
29 SD_VARLINK_DEFINE_ENUM_VALUE(import_raw),
30 SD_VARLINK_FIELD_COMMENT("A local import of a file system tree"),
31 SD_VARLINK_DEFINE_ENUM_VALUE(import_fs),
32 SD_VARLINK_FIELD_COMMENT("A local export of a tarball"),
33 SD_VARLINK_DEFINE_ENUM_VALUE(export_tar),
34 SD_VARLINK_FIELD_COMMENT("A local export of a raw disk image"),
35 SD_VARLINK_DEFINE_ENUM_VALUE(export_raw),
36 SD_VARLINK_FIELD_COMMENT("A download of a tarball"),
37 SD_VARLINK_DEFINE_ENUM_VALUE(pull_tar),
38 SD_VARLINK_FIELD_COMMENT("A download of a raw disk image"),
39 SD_VARLINK_DEFINE_ENUM_VALUE(pull_raw));
40
41 static SD_VARLINK_DEFINE_ENUM_TYPE(
42 ImageVerify,
43 SD_VARLINK_FIELD_COMMENT("No verification"),
44 SD_VARLINK_DEFINE_ENUM_VALUE(no),
45 SD_VARLINK_FIELD_COMMENT("Verify that downloads match checksum file (SHA256SUMS), but do not check signature of checksum file"),
46 SD_VARLINK_DEFINE_ENUM_VALUE(checksum),
47 SD_VARLINK_FIELD_COMMENT("Verify that downloads match checksum file (SHA256SUMS), and check signature of checksum file."),
48 SD_VARLINK_DEFINE_ENUM_VALUE(signature));
49
50 static SD_VARLINK_DEFINE_STRUCT_TYPE(
51 LogMessage,
52 SD_VARLINK_FIELD_COMMENT("The log message"),
53 SD_VARLINK_DEFINE_FIELD(message, SD_VARLINK_STRING, 0),
54 SD_VARLINK_FIELD_COMMENT("The priority of the log message, using the BSD syslog priority levels"),
55 SD_VARLINK_DEFINE_FIELD(priority, SD_VARLINK_INT, 0));
56
57 static SD_VARLINK_DEFINE_METHOD_FULL(
58 ListTransfers,
59 SD_VARLINK_REQUIRES_MORE,
60 SD_VARLINK_FIELD_COMMENT("Image class to filter by"),
61 SD_VARLINK_DEFINE_INPUT_BY_TYPE(class, ImageClass, SD_VARLINK_NULLABLE),
62 SD_VARLINK_FIELD_COMMENT("A unique numeric identifier for the ongoing transfer"),
63 SD_VARLINK_DEFINE_OUTPUT(id, SD_VARLINK_INT, 0),
64 SD_VARLINK_FIELD_COMMENT("The type of transfer"),
65 SD_VARLINK_DEFINE_OUTPUT_BY_TYPE(type, TransferType, 0),
66 SD_VARLINK_FIELD_COMMENT("The remote URL"),
67 SD_VARLINK_DEFINE_OUTPUT(remote, SD_VARLINK_STRING, 0),
68 SD_VARLINK_FIELD_COMMENT("The local image name"),
69 SD_VARLINK_DEFINE_OUTPUT(local, SD_VARLINK_STRING, 0),
70 SD_VARLINK_FIELD_COMMENT("The class of the image"),
71 SD_VARLINK_DEFINE_OUTPUT_BY_TYPE(class, ImageClass, 0),
72 SD_VARLINK_FIELD_COMMENT("Progress in percent"),
73 SD_VARLINK_DEFINE_OUTPUT(percent, SD_VARLINK_FLOAT, 0));
74
75 static SD_VARLINK_DEFINE_METHOD_FULL(
76 Pull,
77 SD_VARLINK_SUPPORTS_MORE,
78 SD_VARLINK_FIELD_COMMENT("The remote URL to download from"),
79 SD_VARLINK_DEFINE_INPUT(remote, SD_VARLINK_STRING, 0),
80 SD_VARLINK_FIELD_COMMENT("The local image name to download to"),
81 SD_VARLINK_DEFINE_INPUT(local, SD_VARLINK_STRING, SD_VARLINK_NULLABLE),
82 SD_VARLINK_FIELD_COMMENT("The type of the resource"),
83 SD_VARLINK_DEFINE_INPUT_BY_TYPE(type, RemoteType, 0),
84 SD_VARLINK_FIELD_COMMENT("The image class"),
85 SD_VARLINK_DEFINE_INPUT_BY_TYPE(class, ImageClass, 0),
86 SD_VARLINK_FIELD_COMMENT("The whether and how thoroughly to verify the download before installing it locally. Defaults to 'signature'."),
87 SD_VARLINK_DEFINE_INPUT_BY_TYPE(verify, ImageVerify, SD_VARLINK_NULLABLE),
88 SD_VARLINK_FIELD_COMMENT("If true, an existing image by the local name is deleted. Defaults to false."),
89 SD_VARLINK_DEFINE_INPUT(force, SD_VARLINK_BOOL, SD_VARLINK_NULLABLE),
90 SD_VARLINK_FIELD_COMMENT("Whether to make the image read-only after downloading. Defaults to false."),
91 SD_VARLINK_DEFINE_INPUT(readOnly, SD_VARLINK_BOOL, SD_VARLINK_NULLABLE),
92 SD_VARLINK_FIELD_COMMENT("Whether to keep a pristine copy of the download separate from the locally installed image. Defaults to false."),
93 SD_VARLINK_DEFINE_INPUT(keepDownload, SD_VARLINK_BOOL, SD_VARLINK_NULLABLE),
94 SD_VARLINK_FIELD_COMMENT("Root directory for images. If not specified derived from the image class, and located below /var/lib/."),
95 SD_VARLINK_DEFINE_INPUT(imageRoot, SD_VARLINK_STRING, SD_VARLINK_NULLABLE),
96 VARLINK_DEFINE_POLKIT_INPUT,
97 SD_VARLINK_FIELD_COMMENT("A progress update, as percent value"),
98 SD_VARLINK_DEFINE_OUTPUT(progress, SD_VARLINK_FLOAT, SD_VARLINK_NULLABLE),
99 SD_VARLINK_FIELD_COMMENT("A log message about the ongoing transfer"),
100 SD_VARLINK_DEFINE_OUTPUT_BY_TYPE(log, LogMessage, SD_VARLINK_NULLABLE),
101 SD_VARLINK_FIELD_COMMENT("The numeric ID of this download"),
102 SD_VARLINK_DEFINE_OUTPUT(id, SD_VARLINK_INT, SD_VARLINK_NULLABLE));
103
104 static SD_VARLINK_DEFINE_ERROR(
105 AlreadyInProgress,
106 SD_VARLINK_FIELD_COMMENT("The URL of the transfer already in progress."),
107 SD_VARLINK_DEFINE_FIELD(remote, SD_VARLINK_STRING, 0));
108 static SD_VARLINK_DEFINE_ERROR(TransferCancelled);
109 static SD_VARLINK_DEFINE_ERROR(TransferFailed);
110 static SD_VARLINK_DEFINE_ERROR(NoTransfers);
111
112 SD_VARLINK_DEFINE_INTERFACE(
113 io_systemd_Import,
114 "io.systemd.Import",
115 SD_VARLINK_SYMBOL_COMMENT("Describes the class of images"),
116 &vl_type_ImageClass,
117 SD_VARLINK_SYMBOL_COMMENT("Describes the type of a images to transfer"),
118 &vl_type_RemoteType,
119 SD_VARLINK_SYMBOL_COMMENT("Describes the type of a transfer"),
120 &vl_type_TransferType,
121 SD_VARLINK_SYMBOL_COMMENT("Describes whether and how thoroughly to verify the download before installing it locally"),
122 &vl_type_ImageVerify,
123 SD_VARLINK_SYMBOL_COMMENT("Structure for log messages associated with a transfer operation"),
124 &vl_type_LogMessage,
125 SD_VARLINK_SYMBOL_COMMENT("List ongoing transfers, or query details about specific transfers"),
126 &vl_method_ListTransfers,
127 SD_VARLINK_SYMBOL_COMMENT("Download a .tar or .raw file. This must be called with the 'more' flag enabled. It will immediately return the numeric ID of the transfer, and then follow up with progress and log message updates, until the transfer is complete."),
128 &vl_method_Pull,
129 SD_VARLINK_SYMBOL_COMMENT("A transfer for the specified file is already ongoing"),
130 &vl_error_AlreadyInProgress,
131 SD_VARLINK_SYMBOL_COMMENT("The transfer has been cancelled on user request"),
132 &vl_error_TransferCancelled,
133 SD_VARLINK_SYMBOL_COMMENT("The transfer failed"),
134 &vl_error_TransferFailed,
135 SD_VARLINK_SYMBOL_COMMENT("No currently ongoing transfer"),
136 &vl_error_NoTransfers);