[PATCH pve-storage v4 04/17] api: plugins/storage/plugin: mark sensitive properties in schema

["Max R. Carrara" <m.carrara@proxmox.com>]

Return a new 'x-sensitive' key as part of a plugin property's schema.

Take the information for this key from the same helper that the
storage config API uses to decide which parameters are sensitive. For
plugins without a 'sensitive-properties' hash in their `plugindata()`,
this helper falls back to a hardcoded list of properties. Otherwise, a
custom plugin reusing e.g. the 'password' property would get a plain
text field in the UI, although the API treats it as sensitive.

Always set the key to either 0 or 1, so that the returned schema has
the same shape for every property.

Signed-off-by: Max R. Carrara <m.carrara@proxmox.com>
---
 src/PVE/API2/Plugins/Storage/Plugin.pm | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/src/PVE/API2/Plugins/Storage/Plugin.pm b/src/PVE/API2/Plugins/Storage/Plugin.pm
index 07909c40..12da9a12 100644
--- a/src/PVE/API2/Plugins/Storage/Plugin.pm
+++ b/src/PVE/API2/Plugins/Storage/Plugin.pm
@@ -40,20 +40,24 @@ my sub get_schema_for_plugin : prototype($) ($plugin) {
     my $type = $plugin->type();
 
     return $PLUGIN_SCHEMAS->{$type} if defined($PLUGIN_SCHEMAS->{$type});
 
     my $options = $plugin->options();
+    # also covers the fallback for plugins without 'sensitive-properties' in their plugindata()
+    my $sensitive = { map { $_ => 1 } PVE::Storage::Plugin::sensitive_properties($type)->@* };
 
     my $schema = {};
     $PLUGIN_SCHEMAS->{$type} = $schema;
 
     for my $option (keys $options->%*) {
         my $prop_schema = PVE::RESTHandler::api_dump_remove_refs(
             PVE::Storage::Plugin->get_property_schema($type, $option));
 
         # shallow copy
         my $property = { $prop_schema->%* };
+        $property->{'x-sensitive'} = $sensitive->{$option} ? 1 : 0;
+
         $schema->{$option} = $property;
 
         for my $opt_key (keys $options->{$option}->%*) {
             $property->{$opt_key} = $options->{$option}->{$opt_key};
         }
-- 
2.47.3