From: Ivan Kruglov Date: Thu, 17 Oct 2024 11:54:07 +0000 (+0200) Subject: machine: add Addresses field in varlink io.systemd.Machine.List output X-Git-Tag: v257-rc1~170^2~2 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=45755275e5ae747bf79e6c7bdd9a055711ebc71f;p=thirdparty%2Fsystemd.git machine: add Addresses field in varlink io.systemd.Machine.List output This is equivalent to DBus implementation of GetMachineAddresses. --- diff --git a/src/machine/machined-varlink.c b/src/machine/machined-varlink.c index bf0debb631c..88db2cf632c 100644 --- a/src/machine/machined-varlink.c +++ b/src/machine/machined-varlink.c @@ -391,10 +391,38 @@ static int vl_method_get_memberships(sd_varlink *link, sd_json_variant *paramete return sd_varlink_error(link, "io.systemd.UserDatabase.NoRecordFound", NULL); } +static int json_build_local_addresses(const struct local_address *addresses, size_t n_addresses, sd_json_variant **ret) { + int r; + + if (n_addresses == 0) + return 0; + + assert(addresses); + assert(ret); + + FOREACH_ARRAY(a, addresses, n_addresses) { + _cleanup_(sd_json_variant_unrefp) sd_json_variant *entry = NULL; + r = sd_json_buildo( + &entry, + JSON_BUILD_PAIR_UNSIGNED_NON_ZERO("ifindex", a->ifindex), + SD_JSON_BUILD_PAIR_INTEGER("family", a->family), + SD_JSON_BUILD_PAIR_BYTE_ARRAY("address", &a->address.bytes, FAMILY_ADDRESS_SIZE(a->family))); + if (r < 0) + return r; + + r = sd_json_variant_append_array(ret, entry); + if (r < 0) + return r; + } + + return 0; +} + static int list_machine_one_and_maybe_read_metadata(sd_varlink *link, Machine *m, bool more, AcquireMetadata am) { + _cleanup_(sd_json_variant_unrefp) sd_json_variant *addr_array = NULL; _cleanup_strv_free_ char **os_release = NULL; uid_t shift = UID_INVALID; - int n, r; + int r, n = 0; assert(link); assert(m); @@ -402,6 +430,22 @@ static int list_machine_one_and_maybe_read_metadata(sd_varlink *link, Machine *m _cleanup_(sd_json_variant_unrefp) sd_json_variant *v = NULL; if (should_acquire_metadata(am)) { + _cleanup_free_ struct local_address *addresses = NULL; + n = machine_get_addresses(m, &addresses); + if (n < 0 && am == ACQUIRE_METADATA_GRACEFUL) + log_debug_errno(n, "Failed to get address (graceful mode), ignoring: %m"); + else if (n == -ENONET) + return sd_varlink_error(link, "io.systemd.Machine.NoPrivateNetworking", NULL); + else if (ERRNO_IS_NEG_NOT_SUPPORTED(n)) + return sd_varlink_error(link, "io.systemd.Machine.NotAvailable", NULL); + else if (n < 0) + return log_debug_errno(n, "Failed to get addresses: %m"); + else { + r = json_build_local_addresses(addresses, n, &addr_array); + if (r < 0) + return r; + } + r = machine_get_os_release(m, &os_release); if (r < 0 && am == ACQUIRE_METADATA_GRACEFUL) log_debug_errno(r, "Failed to get OS release (graceful mode), ignoring: %m"); @@ -436,6 +480,7 @@ static int list_machine_one_and_maybe_read_metadata(sd_varlink *link, Machine *m SD_JSON_BUILD_PAIR_CONDITION(m->vsock_cid != VMADDR_CID_ANY, "vSockCid", SD_JSON_BUILD_UNSIGNED(m->vsock_cid)), JSON_BUILD_PAIR_STRING_NON_EMPTY("sshAddress", m->ssh_address), JSON_BUILD_PAIR_STRING_NON_EMPTY("sshPrivateKeyPath", m->ssh_private_key_path), + SD_JSON_BUILD_PAIR_CONDITION(n > 0, "addresses", SD_JSON_BUILD_VARIANT(addr_array)), SD_JSON_BUILD_PAIR_CONDITION(!strv_isempty(os_release), "OSRelease", JSON_BUILD_STRV_ENV_PAIR(os_release)), JSON_BUILD_PAIR_UNSIGNED_NOT_EQUAL("UIDShift", shift, UID_INVALID)); if (r < 0) diff --git a/src/shared/varlink-io.systemd.Machine.c b/src/shared/varlink-io.systemd.Machine.c index 9b79b86004d..3b44f80854f 100644 --- a/src/shared/varlink-io.systemd.Machine.c +++ b/src/shared/varlink-io.systemd.Machine.c @@ -22,6 +22,12 @@ static SD_VARLINK_DEFINE_ENUM_TYPE( SD_VARLINK_FIELD_COMMENT("Include metadata in the output, but gracefully eat up errors"), SD_VARLINK_DEFINE_ENUM_VALUE(graceful)); +static SD_VARLINK_DEFINE_STRUCT_TYPE( + Address, + SD_VARLINK_DEFINE_FIELD(ifindex, SD_VARLINK_INT, SD_VARLINK_NULLABLE), + SD_VARLINK_DEFINE_FIELD(family, SD_VARLINK_INT, 0), + SD_VARLINK_DEFINE_FIELD(address, SD_VARLINK_INT, SD_VARLINK_ARRAY)); + static SD_VARLINK_DEFINE_METHOD( Register, SD_VARLINK_DEFINE_INPUT(name, SD_VARLINK_STRING, 0), @@ -58,7 +64,7 @@ static SD_VARLINK_DEFINE_METHOD_FULL( List, SD_VARLINK_SUPPORTS_MORE, VARLINK_DEFINE_MACHINE_LOOKUP_AND_POLKIT_INPUT_FIELDS, - SD_VARLINK_FIELD_COMMENT("If 'yes' the output will include machine metadata fields such as 'OSRelease' and 'UIDShift'. If 'graceful' it's equal to true but gracefully eats up errors"), + SD_VARLINK_FIELD_COMMENT("If 'yes' the output will include machine metadata fields such as 'Addresses', 'OSRelease', and 'UIDShift'. If 'graceful' it's equal to true but gracefully eats up errors"), SD_VARLINK_DEFINE_INPUT_BY_TYPE(acquireMetadata, AcquireMetadata, SD_VARLINK_NULLABLE), SD_VARLINK_FIELD_COMMENT("Name of the machine"), SD_VARLINK_DEFINE_OUTPUT(name, SD_VARLINK_STRING, 0), @@ -82,6 +88,8 @@ static SD_VARLINK_DEFINE_METHOD_FULL( SD_VARLINK_DEFINE_OUTPUT(sshAddress, SD_VARLINK_STRING, SD_VARLINK_NULLABLE), SD_VARLINK_FIELD_COMMENT("Path to private SSH key"), SD_VARLINK_DEFINE_OUTPUT(sshPrivateKeyPath, SD_VARLINK_STRING, SD_VARLINK_NULLABLE), + SD_VARLINK_FIELD_COMMENT("List of addresses of the machine"), + SD_VARLINK_DEFINE_OUTPUT_BY_TYPE(addresses, Address, SD_VARLINK_ARRAY | SD_VARLINK_NULLABLE), SD_VARLINK_FIELD_COMMENT("OS release information of the machine. It contains an array of key value pairs read from the os-release(5) file in the image."), SD_VARLINK_DEFINE_OUTPUT(OSRelease, SD_VARLINK_STRING, SD_VARLINK_NULLABLE|SD_VARLINK_ARRAY), SD_VARLINK_FIELD_COMMENT("Return the base UID/GID of the machine"), @@ -89,6 +97,7 @@ static SD_VARLINK_DEFINE_METHOD_FULL( static SD_VARLINK_DEFINE_ERROR(NoSuchMachine); static SD_VARLINK_DEFINE_ERROR(MachineExists); +static SD_VARLINK_DEFINE_ERROR(NoPrivateNetworking); static SD_VARLINK_DEFINE_ERROR(NoOSReleaseInformation); static SD_VARLINK_DEFINE_ERROR(NoUIDShift); static SD_VARLINK_DEFINE_ERROR(NotAvailable); @@ -102,6 +111,8 @@ SD_VARLINK_DEFINE_INTERFACE( &vl_type_Timestamp, SD_VARLINK_SYMBOL_COMMENT("A enum field allowing to gracefully get metadata"), &vl_type_AcquireMetadata, + SD_VARLINK_SYMBOL_COMMENT("An address object"), + &vl_type_Address, &vl_method_Register, &vl_method_Unregister, SD_VARLINK_SYMBOL_COMMENT("Terminate machine, killing its processes"), @@ -113,6 +124,8 @@ SD_VARLINK_DEFINE_INTERFACE( SD_VARLINK_SYMBOL_COMMENT("No matching machine currently running"), &vl_error_NoSuchMachine, &vl_error_MachineExists, + SD_VARLINK_SYMBOL_COMMENT("Machine does not use private networking"), + &vl_error_NoPrivateNetworking, SD_VARLINK_SYMBOL_COMMENT("Machine does not contain OS release information"), &vl_error_NoOSReleaseInformation, SD_VARLINK_SYMBOL_COMMENT("Machine uses a complex UID/GID mapping, cannot determine shift"),