From mboxrd@z Thu Jan 1 00:00:00 1970
Return-Path: <pve-devel-bounces@lists.proxmox.com>
Received: from firstgate.proxmox.com (firstgate.proxmox.com [IPv6:2a01:7e0:0:424::9])
by lore.proxmox.com (Postfix) with ESMTPS id 03FD61FF17C
for <inbox@lore.proxmox.com>; Wed, 2 Apr 2025 12:02:34 +0200 (CEST)
Received: from firstgate.proxmox.com (localhost [127.0.0.1])
by firstgate.proxmox.com (Proxmox) with ESMTP id 8CFE1E617;
Wed, 2 Apr 2025 12:02:23 +0200 (CEST)
Mime-Version: 1.0
Date: Wed, 02 Apr 2025 12:01:49 +0200
Message-Id: <D8W2EFQ6SMQ1.2BDU7R9ABPS8G@proxmox.com>
To: "Proxmox VE development discussion" <pve-devel@lists.proxmox.com>
From: "Max Carrara" <m.carrara@proxmox.com>
X-Mailer: aerc 0.18.2-0-ge037c095a049
References: <20250401173435.221892-1-f.ebner@proxmox.com>
<20250401173435.221892-14-f.ebner@proxmox.com>
In-Reply-To: <20250401173435.221892-14-f.ebner@proxmox.com>
X-SPAM-LEVEL: Spam detection results: 0
AWL -0.175 Adjusted score from AWL reputation of From: address
BAYES_00 -1.9 Bayes spam probability is 0 to 1%
DMARC_MISSING 0.1 Missing DMARC policy
KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment
RCVD_IN_VALIDITY_CERTIFIED_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to
Validity was blocked. See
https://knowledge.validity.com/hc/en-us/articles/20961730681243 for more
information.
RCVD_IN_VALIDITY_RPBL_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to
Validity was blocked. See
https://knowledge.validity.com/hc/en-us/articles/20961730681243 for more
information.
RCVD_IN_VALIDITY_SAFE_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to
Validity was blocked. See
https://knowledge.validity.com/hc/en-us/articles/20961730681243 for more
information.
SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record
SPF_PASS -0.001 SPF: sender matches SPF record
URIBL_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to URIBL was blocked. See
http://wiki.apache.org/spamassassin/DnsBlocklists#dnsbl-block for more
information. [nfsplugin.pm, glusterfsplugin.pm]
URI_NOVOWEL 0.5 URI hostname has long non-vowel sequence
Subject: Re: [pve-devel] [PATCH storage v7 13/37] config api/plugins: let
plugins define sensitive properties themselves
X-BeenThere: pve-devel@lists.proxmox.com
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: Proxmox VE development discussion <pve-devel.lists.proxmox.com>
List-Unsubscribe: <https://lists.proxmox.com/cgi-bin/mailman/options/pve-devel>,
<mailto:pve-devel-request@lists.proxmox.com?subject=unsubscribe>
List-Archive: <http://lists.proxmox.com/pipermail/pve-devel/>
List-Post: <mailto:pve-devel@lists.proxmox.com>
List-Help: <mailto:pve-devel-request@lists.proxmox.com?subject=help>
List-Subscribe: <https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel>,
<mailto:pve-devel-request@lists.proxmox.com?subject=subscribe>
Reply-To: Proxmox VE development discussion <pve-devel@lists.proxmox.com>
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: 7bit
Errors-To: pve-devel-bounces@lists.proxmox.com
Sender: "pve-devel" <pve-devel-bounces@lists.proxmox.com>
On Tue Apr 1, 2025 at 7:34 PM CEST, Fiona Ebner wrote:
> 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.
I think this is great, this is just what I needed ;)
>
> 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' => {},
> };
> }
>
_______________________________________________
pve-devel mailing list
pve-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel