public inbox for pve-devel@lists.proxmox.com
 help / color / mirror / Atom feed
From: Fiona Ebner <f.ebner@proxmox.com>
To: pve-devel@lists.proxmox.com
Subject: [pve-devel] [PATCH storage v6 13/37] config api/plugins: let plugins define sensitive properties themselves
Date: Mon, 31 Mar 2025 15:19:56 +0200	[thread overview]
Message-ID: <20250331132020.105324-14-f.ebner@proxmox.com> (raw)
In-Reply-To: <20250331132020.105324-1-f.ebner@proxmox.com>

Hard-coding a list of sensitive properties means that custom plugins
cannot define their own sensitive properties for the on_add/on_update
hooks.

Have plugins declare the list of their sensitive properties in the
plugin data. For backwards compatibility, return the previously
hard-coded list if no such declaration is present.

Signed-off-by: Fiona Ebner <f.ebner@proxmox.com>
---
 src/PVE/API2/Storage/Config.pm       |  4 ++--
 src/PVE/Storage/BTRFSPlugin.pm       |  1 +
 src/PVE/Storage/CIFSPlugin.pm        |  1 +
 src/PVE/Storage/CephFSPlugin.pm      |  1 +
 src/PVE/Storage/DirPlugin.pm         |  1 +
 src/PVE/Storage/ESXiPlugin.pm        |  1 +
 src/PVE/Storage/GlusterfsPlugin.pm   |  1 +
 src/PVE/Storage/ISCSIDirectPlugin.pm |  1 +
 src/PVE/Storage/ISCSIPlugin.pm       |  1 +
 src/PVE/Storage/LVMPlugin.pm         |  1 +
 src/PVE/Storage/LvmThinPlugin.pm     |  1 +
 src/PVE/Storage/NFSPlugin.pm         |  1 +
 src/PVE/Storage/PBSPlugin.pm         |  5 +++++
 src/PVE/Storage/Plugin.pm            | 12 ++++++++++++
 src/PVE/Storage/RBDPlugin.pm         |  1 +
 src/PVE/Storage/ZFSPlugin.pm         |  1 +
 src/PVE/Storage/ZFSPoolPlugin.pm     |  1 +
 17 files changed, 33 insertions(+), 2 deletions(-)

diff --git a/src/PVE/API2/Storage/Config.pm b/src/PVE/API2/Storage/Config.pm
index e04b6ab..7facc62 100755
--- a/src/PVE/API2/Storage/Config.pm
+++ b/src/PVE/API2/Storage/Config.pm
@@ -190,8 +190,6 @@ __PACKAGE__->register_method ({
 	return &$api_storage_config($cfg, $param->{storage});
     }});
 
-my $sensitive_params = [qw(password encryption-key master-pubkey keyring)];
-
 __PACKAGE__->register_method ({
     name => 'create',
     protected => 1,
@@ -239,6 +237,7 @@ __PACKAGE__->register_method ({
 	# fix me in section config create never need an empty entity.
 	delete $param->{nodes} if !$param->{nodes};
 
+	my $sensitive_params = PVE::Storage::Plugin::sensitive_properties($type);
 	my $sensitive = extract_sensitive_params($param, $sensitive_params, []);
 
 	my $plugin = PVE::Storage::Plugin->lookup($type);
@@ -344,6 +343,7 @@ __PACKAGE__->register_method ({
 	    my $scfg = PVE::Storage::storage_config($cfg, $storeid);
 	    $type = $scfg->{type};
 
+	    my $sensitive_params = PVE::Storage::Plugin::sensitive_properties($type);
 	    my $sensitive = extract_sensitive_params($param, $sensitive_params, $delete);
 
 	    my $plugin = PVE::Storage::Plugin->lookup($type);
diff --git a/src/PVE/Storage/BTRFSPlugin.pm b/src/PVE/Storage/BTRFSPlugin.pm
index 1966b6f..5ed910d 100644
--- a/src/PVE/Storage/BTRFSPlugin.pm
+++ b/src/PVE/Storage/BTRFSPlugin.pm
@@ -45,6 +45,7 @@ sub plugindata {
 	    { images => 1, rootdir => 1 },
 	],
 	format => [ { raw => 1, subvol => 1 }, 'raw', ],
+	'sensitive-properties' => {},
     };
 }
 
diff --git a/src/PVE/Storage/CIFSPlugin.pm b/src/PVE/Storage/CIFSPlugin.pm
index 475065a..f47861e 100644
--- a/src/PVE/Storage/CIFSPlugin.pm
+++ b/src/PVE/Storage/CIFSPlugin.pm
@@ -101,6 +101,7 @@ sub plugindata {
 	content => [ { images => 1, rootdir => 1, vztmpl => 1, iso => 1,
 		   backup => 1, snippets => 1, import => 1}, { images => 1 }],
 	format => [ { raw => 1, qcow2 => 1, vmdk => 1 } , 'raw' ],
+	'sensitive-properties' => { password => 1 },
     };
 }
 
diff --git a/src/PVE/Storage/CephFSPlugin.pm b/src/PVE/Storage/CephFSPlugin.pm
index 36c64ea..73edecb 100644
--- a/src/PVE/Storage/CephFSPlugin.pm
+++ b/src/PVE/Storage/CephFSPlugin.pm
@@ -118,6 +118,7 @@ sub plugindata {
     return {
 	content => [ { vztmpl => 1, iso => 1, backup => 1, snippets => 1, import => 1 },
 		     { backup => 1 }],
+	'sensitive-properties' => { keyring => 1 },
     };
 }
 
diff --git a/src/PVE/Storage/DirPlugin.pm b/src/PVE/Storage/DirPlugin.pm
index fb23e0a..532701b 100644
--- a/src/PVE/Storage/DirPlugin.pm
+++ b/src/PVE/Storage/DirPlugin.pm
@@ -26,6 +26,7 @@ sub plugindata {
 	content => [ { images => 1, rootdir => 1, vztmpl => 1, iso => 1, backup => 1, snippets => 1, none => 1, import => 1 },
 		     { images => 1,  rootdir => 1 }],
 	format => [ { raw => 1, qcow2 => 1, vmdk => 1, subvol => 1 } , 'raw' ],
+	'sensitive-properties' => {},
     };
 }
 
diff --git a/src/PVE/Storage/ESXiPlugin.pm b/src/PVE/Storage/ESXiPlugin.pm
index c8412c4..6131c51 100644
--- a/src/PVE/Storage/ESXiPlugin.pm
+++ b/src/PVE/Storage/ESXiPlugin.pm
@@ -31,6 +31,7 @@ sub plugindata {
     return {
 	content => [ { import => 1 }, { import => 1 }],
 	format => [ { raw => 1, qcow2 => 1, vmdk => 1 } , 'raw' ],
+	'sensitive-properties' => { password => 1 },
     };
 }
 
diff --git a/src/PVE/Storage/GlusterfsPlugin.pm b/src/PVE/Storage/GlusterfsPlugin.pm
index 9d17180..18493cb 100644
--- a/src/PVE/Storage/GlusterfsPlugin.pm
+++ b/src/PVE/Storage/GlusterfsPlugin.pm
@@ -100,6 +100,7 @@ sub plugindata {
 	content => [ { images => 1, vztmpl => 1, iso => 1, backup => 1, snippets => 1, import => 1},
 		     { images => 1 }],
 	format => [ { raw => 1, qcow2 => 1, vmdk => 1 } , 'raw' ],
+	'sensitive-properties' => {},
     };
 }
 
diff --git a/src/PVE/Storage/ISCSIDirectPlugin.pm b/src/PVE/Storage/ISCSIDirectPlugin.pm
index 60bc94e..829e0c4 100644
--- a/src/PVE/Storage/ISCSIDirectPlugin.pm
+++ b/src/PVE/Storage/ISCSIDirectPlugin.pm
@@ -60,6 +60,7 @@ sub plugindata {
     return {
 	content => [ {images => 1, none => 1}, { images => 1 }],
 	select_existing => 1,
+	'sensitive-properties' => {},
     };
 }
 
diff --git a/src/PVE/Storage/ISCSIPlugin.pm b/src/PVE/Storage/ISCSIPlugin.pm
index 2c608a4..39cb4a7 100644
--- a/src/PVE/Storage/ISCSIPlugin.pm
+++ b/src/PVE/Storage/ISCSIPlugin.pm
@@ -305,6 +305,7 @@ sub plugindata {
     return {
 	content => [ {images => 1, none => 1}, { images => 1 }],
 	select_existing => 1,
+	'sensitive-properties' => {},
     };
 }
 
diff --git a/src/PVE/Storage/LVMPlugin.pm b/src/PVE/Storage/LVMPlugin.pm
index 38f7fa1..2ebec88 100644
--- a/src/PVE/Storage/LVMPlugin.pm
+++ b/src/PVE/Storage/LVMPlugin.pm
@@ -218,6 +218,7 @@ sub type {
 sub plugindata {
     return {
 	content => [ {images => 1, rootdir => 1}, { images => 1 }],
+	'sensitive-properties' => {},
     };
 }
 
diff --git a/src/PVE/Storage/LvmThinPlugin.pm b/src/PVE/Storage/LvmThinPlugin.pm
index 4b23623..49a4dcb 100644
--- a/src/PVE/Storage/LvmThinPlugin.pm
+++ b/src/PVE/Storage/LvmThinPlugin.pm
@@ -31,6 +31,7 @@ sub type {
 sub plugindata {
     return {
 	content => [ {images => 1, rootdir => 1}, { images => 1, rootdir => 1}],
+	'sensitive-properties' => {},
     };
 }
 
diff --git a/src/PVE/Storage/NFSPlugin.pm b/src/PVE/Storage/NFSPlugin.pm
index 72e9c6d..cb2ae18 100644
--- a/src/PVE/Storage/NFSPlugin.pm
+++ b/src/PVE/Storage/NFSPlugin.pm
@@ -56,6 +56,7 @@ sub plugindata {
 	content => [ { images => 1, rootdir => 1, vztmpl => 1, iso => 1, backup => 1, snippets => 1, import => 1 },
 		     { images => 1 }],
 	format => [ { raw => 1, qcow2 => 1, vmdk => 1 } , 'raw' ],
+	'sensitive-properties' => {},
     };
 }   
 
diff --git a/src/PVE/Storage/PBSPlugin.pm b/src/PVE/Storage/PBSPlugin.pm
index 0808bcc..9f75794 100644
--- a/src/PVE/Storage/PBSPlugin.pm
+++ b/src/PVE/Storage/PBSPlugin.pm
@@ -30,6 +30,11 @@ sub type {
 sub plugindata {
     return {
 	content => [ {backup => 1, none => 1}, { backup => 1 }],
+	'sensitive-properties' => {
+	    'encryption-key' => 1,
+	    'master-pubkey' => 1,
+	    password => 1,
+	},
     };
 }
 
diff --git a/src/PVE/Storage/Plugin.pm b/src/PVE/Storage/Plugin.pm
index df2ddc5..0d9558c 100644
--- a/src/PVE/Storage/Plugin.pm
+++ b/src/PVE/Storage/Plugin.pm
@@ -246,6 +246,18 @@ sub dirs_hash_to_string {
     return join(',', map { "$_=$hash->{$_}" } sort keys %$hash);
 }
 
+sub sensitive_properties {
+    my ($type) = @_;
+
+    my $data = $defaultData->{plugindata}->{$type};
+    if (my $sensitive_properties = $data->{'sensitive-properties'}) {
+	return [sort keys $sensitive_properties->%*];
+    }
+
+    # For backwards compatibility. This list was hardcoded in the API module previously.
+    return [qw(encryption-key keyring master-pubkey password)];
+}
+
 sub storage_has_feature {
     my ($type, $feature) = @_;
 
diff --git a/src/PVE/Storage/RBDPlugin.pm b/src/PVE/Storage/RBDPlugin.pm
index 42eefc6..c78db00 100644
--- a/src/PVE/Storage/RBDPlugin.pm
+++ b/src/PVE/Storage/RBDPlugin.pm
@@ -380,6 +380,7 @@ sub type {
 sub plugindata {
     return {
 	content => [ {images => 1, rootdir => 1}, { images => 1 }],
+	'sensitive-properties' => { keyring => 1 },
     };
 }
 
diff --git a/src/PVE/Storage/ZFSPlugin.pm b/src/PVE/Storage/ZFSPlugin.pm
index d4dc2a4..94cb11f 100644
--- a/src/PVE/Storage/ZFSPlugin.pm
+++ b/src/PVE/Storage/ZFSPlugin.pm
@@ -175,6 +175,7 @@ sub type {
 sub plugindata {
     return {
 	content => [ {images => 1}, { images => 1 }],
+	'sensitive-properties' => {},
     };
 }
 
diff --git a/src/PVE/Storage/ZFSPoolPlugin.pm b/src/PVE/Storage/ZFSPoolPlugin.pm
index 3669fe1..26fb0a4 100644
--- a/src/PVE/Storage/ZFSPoolPlugin.pm
+++ b/src/PVE/Storage/ZFSPoolPlugin.pm
@@ -22,6 +22,7 @@ sub plugindata {
     return {
 	content => [ {images => 1, rootdir => 1}, {images => 1 , rootdir => 1}],
 	format => [ { raw => 1, subvol => 1 } , 'raw' ],
+	'sensitive-properties' => {},
     };
 }
 
-- 
2.39.5



_______________________________________________
pve-devel mailing list
pve-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel


  parent reply	other threads:[~2025-03-31 13:22 UTC|newest]

Thread overview: 41+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-03-31 13:19 [pve-devel] [PATCH-SERIES qemu/common/storage/qemu-server/container/manager v6 00/37] backup provider API Fiona Ebner
2025-03-31 13:19 ` [pve-devel] [PATCH qemu v6 01/37] PVE backup: clean up directly in setup_snapshot_access() when it fails Fiona Ebner
2025-03-31 13:19 ` [pve-devel] [PATCH qemu v6 02/37] PVE backup: factor out helper to clear backup state's bitmap list Fiona Ebner
2025-03-31 13:19 ` [pve-devel] [PATCH qemu v6 03/37] PVE backup: factor out helper to initialize backup state stat struct Fiona Ebner
2025-03-31 13:19 ` [pve-devel] [PATCH qemu v6 04/37] PVE backup: add target ID in backup state Fiona Ebner
2025-03-31 13:19 ` [pve-devel] [PATCH qemu v6 05/37] PVE backup: get device info: allow caller to specify filter for which devices use fleecing Fiona Ebner
2025-03-31 13:19 ` [pve-devel] [PATCH qemu v6 06/37] PVE backup: implement backup access setup and teardown API for external providers Fiona Ebner
2025-03-31 13:19 ` [pve-devel] [PATCH qemu v6 07/37] PVE backup: implement bitmap support for external backup access Fiona Ebner
2025-03-31 13:19 ` [pve-devel] [PATCH qemu v6 08/37] PVE backup: backup-access api: indicate situation where a bitmap was recreated Fiona Ebner
2025-03-31 13:19 ` [pve-devel] [PATCH common v6 09/37] syscall: expose fallocate syscall Fiona Ebner
2025-03-31 14:34   ` [pve-devel] applied: " Thomas Lamprecht
2025-03-31 13:19 ` [pve-devel] [PATCH storage v6 10/37] add storage_has_feature() helper function Fiona Ebner
2025-03-31 13:19 ` [pve-devel] [PATCH storage v6 11/37] common: add deallocate " Fiona Ebner
2025-03-31 13:19 ` [pve-devel] [PATCH storage v6 12/37] plugin: introduce new_backup_provider() method Fiona Ebner
2025-03-31 13:19 ` Fiona Ebner [this message]
2025-03-31 13:19 ` [pve-devel] [PATCH storage v6 14/37] plugin api: bump api version and age Fiona Ebner
2025-03-31 13:19 ` [pve-devel] [PATCH storage v6 15/37] extract backup config: delegate to backup provider for storages that support it Fiona Ebner
2025-03-31 13:19 ` [pve-devel] [POC storage v6 16/37] add backup provider example Fiona Ebner
2025-03-31 13:20 ` [pve-devel] [POC storage v6 17/37] Borg example plugin Fiona Ebner
2025-03-31 13:20 ` [pve-devel] [PATCH qemu-server v6 18/37] backup: keep track of block-node size for fleecing Fiona Ebner
2025-03-31 13:20 ` [pve-devel] [PATCH qemu-server v6 19/37] backup: fleecing: use exact size when allocating non-raw fleecing images Fiona Ebner
2025-03-31 13:20 ` [pve-devel] [PATCH qemu-server v6 20/37] backup: allow adding fleecing images also for EFI and TPM Fiona Ebner
2025-03-31 13:20 ` [pve-devel] [PATCH qemu-server v6 21/37] backup: implement backup for external providers Fiona Ebner
2025-03-31 13:20 ` [pve-devel] [PATCH qemu-server v6 22/37] test: qemu img convert: add test cases for snapshots Fiona Ebner
2025-03-31 13:20 ` [pve-devel] [PATCH qemu-server v6 23/37] image convert: collect options in hash argument Fiona Ebner
2025-03-31 13:20 ` [pve-devel] [PATCH qemu-server v6 24/37] image convert: allow caller to specify the format of the source path Fiona Ebner
2025-03-31 13:20 ` [pve-devel] [PATCH qemu-server v6 25/37] backup: implement restore for external providers Fiona Ebner
2025-03-31 13:20 ` [pve-devel] [PATCH qemu-server v6 26/37] backup: future-proof checks for QEMU feature support Fiona Ebner
2025-03-31 13:20 ` [pve-devel] [PATCH qemu-server v6 27/37] backup: support 'missing-recreated' bitmap action Fiona Ebner
2025-03-31 13:20 ` [pve-devel] [PATCH qemu-server v6 28/37] backup: bitmap action to human: lie about TPM state Fiona Ebner
2025-03-31 13:20 ` [pve-devel] [PATCH container v6 29/37] add LXC::Namespaces module Fiona Ebner
2025-03-31 13:20 ` [pve-devel] [PATCH container v6 30/37] backup: implement backup for external providers Fiona Ebner
2025-03-31 13:20 ` [pve-devel] [PATCH container v6 31/37] backup: implement restore " Fiona Ebner
2025-03-31 13:20 ` [pve-devel] [PATCH container v6 32/37] external restore: don't use 'one-file-system' tar flag when restoring from a directory Fiona Ebner
2025-03-31 13:20 ` [pve-devel] [PATCH container v6 33/37] create: factor out compression option helper Fiona Ebner
2025-03-31 13:20 ` [pve-devel] [PATCH container v6 34/37] restore tar archive: check potentially untrusted archive Fiona Ebner
2025-03-31 13:20 ` [pve-devel] [PATCH container v6 35/37] api: add early check against restoring privileged container from external source Fiona Ebner
2025-03-31 13:20 ` [pve-devel] [PATCH manager v6 36/37] ui: backup: also check for backup subtype to classify archive Fiona Ebner
2025-03-31 13:20 ` [pve-devel] [PATCH manager v6 37/37] backup: implement backup for external providers Fiona Ebner
2025-04-01  8:15 ` [pve-devel] [PATCH-SERIES qemu/common/storage/qemu-server/container/manager v6 00/37] backup provider API Fiona Ebner
2025-04-01  8:26 ` [pve-devel] [FOLLOWUP storage] backup provider: base: document limitation of backup_container() method Fiona Ebner

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20250331132020.105324-14-f.ebner@proxmox.com \
    --to=f.ebner@proxmox.com \
    --cc=pve-devel@lists.proxmox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal