From: Dominik Csapak <d.csapak@proxmox.com>
To: pve-devel@lists.proxmox.com
Subject: [pve-devel] [PATCH guest-common v11 1/1] GuestHelpers: add tag related helpers
Date: Wed, 16 Nov 2022 16:48:00 +0100 [thread overview]
Message-ID: <20221116154815.358385-7-d.csapak@proxmox.com> (raw)
In-Reply-To: <20221116154815.358385-1-d.csapak@proxmox.com>
'get_allowed_tags':
returns the allowed tags for the given user
'assert_tag_permissions'
helper to check permissions for tag setting/updating/deleting
for both container and qemu-server
gets the list of allowed tags from the DataCenterConfig and the current
user permissions, and checks for each tag that is added/removed if
the user has permissions to modify it
'normal' tags require 'VM.Config.Options' on '/vms/<vmid>', but not
allowed tags (either limited with 'user-tag-access' or
'privileged-tags' in the datacenter.cfg) requrie 'Sys.Modify' on '/'
Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
---
debian/control | 3 +-
src/PVE/GuestHelpers.pm | 99 ++++++++++++++++++++++++++++++++++++++++-
2 files changed, 100 insertions(+), 2 deletions(-)
diff --git a/debian/control b/debian/control
index 83bade3..ffff22b 100644
--- a/debian/control
+++ b/debian/control
@@ -12,7 +12,8 @@ Homepage: https://www.proxmox.com
Package: libpve-guest-common-perl
Architecture: all
-Depends: libpve-cluster-perl,
+Depends: libpve-access-control,
+ libpve-cluster-perl,
libpve-common-perl (>= 7.2-6),
libpve-storage-perl (>= 7.0-14),
pve-cluster,
diff --git a/src/PVE/GuestHelpers.pm b/src/PVE/GuestHelpers.pm
index 0fe3fd6..a99a0ad 100644
--- a/src/PVE/GuestHelpers.pm
+++ b/src/PVE/GuestHelpers.pm
@@ -3,6 +3,7 @@ package PVE::GuestHelpers;
use strict;
use warnings;
+use PVE::Exception qw(raise_perm_exc);
use PVE::Tools;
use PVE::Storage;
@@ -11,7 +12,14 @@ use Scalar::Util qw(weaken);
use base qw(Exporter);
-our @EXPORT_OK = qw(safe_string_ne safe_boolean_ne safe_num_ne typesafe_ne);
+our @EXPORT_OK = qw(
+assert_tag_permissions
+get_allowed_tags
+safe_boolean_ne
+safe_num_ne
+safe_string_ne
+typesafe_ne
+);
# We use a separate lock to block migration while a replication job
# is running.
@@ -246,4 +254,93 @@ sub config_with_pending_array {
return $res;
}
+# returns the allowed tags for the given user
+# in scalar context, returns the list of allowed tags that exist
+# in list context, returns a tuple of allowed tags, privileged tags, and if freeform is enabled
+#
+# first parameter is a bool if the user is 'privileged' (normally Sys.Modify on /)
+# second parameter is a closure which takes the vmid. should check if the user can see the vm tags
+sub get_allowed_tags {
+ my ($rpcenv, $user, $privileged_user) = @_;
+
+ $privileged_user //= ($rpcenv->check($user, '/', ['Sys.Modify'], 1) // 0);
+
+ my $dc = PVE::Cluster::cfs_read_file('datacenter.cfg');
+
+ my $allowed_tags = {};
+ my $privileged_tags = {};
+ if (my $tags = $dc->{'registered-tags'}) {
+ $privileged_tags->{$_} = 1 for $tags->@*;
+ }
+ my $user_tag_privs = $dc->{'user-tag-access'} // {};
+ my $user_allow = $user_tag_privs->{'user-allow'} // 'free';
+ my $freeform = $user_allow eq 'free';
+
+ if ($user_allow ne 'none' || $privileged_user) {
+ $allowed_tags->{$_} = 1 for ($user_tag_privs->{'user-allow-list'} // [])->@*;
+ }
+
+ if ($user_allow eq 'free' || $user_allow eq 'existing' || $privileged_user) {
+ my $props = PVE::Cluster::get_guest_config_properties(['tags']);
+ for my $vmid (keys $props->%*) {
+ next if !$privileged_user && !$rpcenv->check_vm_perm($user, $vmid, undef, ['VM.Audit'], 0, 1);
+ $allowed_tags->{$_} = 1 for PVE::Tools::split_list($props->{$vmid}->{tags});
+ }
+ }
+
+ if ($privileged_user) {
+ $allowed_tags->{$_} = 1 for keys $privileged_tags->%*;
+ } else {
+ delete $allowed_tags->{$_} for keys $privileged_tags->%*;
+ }
+
+ return wantarray ? ($allowed_tags, $privileged_tags, $freeform) : $allowed_tags;
+}
+
+# checks the permissions for setting/updating/removing tags for guests
+# tagopt_old and tagopt_new expect the tags as they are in the config
+#
+# either returns gracefully or raises a permission exception
+sub assert_tag_permissions {
+ my ($vmid, $tagopt_old, $tagopt_new, $rpcenv, $authuser) = @_;
+
+ my $allowed_tags;
+ my $privileged_tags;
+ my $freeform;
+ my $privileged_user = $rpcenv->check($authuser, '/', ['Sys.Modify'], 1) // 0;
+
+ $rpcenv->check_vm_perm($authuser, $vmid, undef, ['VM.Config.Options']);
+
+ my $check_single_tag = sub {
+ my ($tag) = @_;
+ return if $privileged_user;
+
+ if (!defined($allowed_tags) && !defined($privileged_tags) && !defined($freeform)) {
+ ($allowed_tags, $privileged_tags, $freeform) = get_allowed_tags(
+ $rpcenv,
+ $authuser,
+ $privileged_user,
+ );
+ }
+
+ if ((!$allowed_tags->{$tag} && !$freeform) || $privileged_tags->{$tag}) {
+ raise_perm_exc("/, Sys.Modify for modifying tag '$tag'");
+ }
+
+ return;
+ };
+
+ my $old_tags = {};
+ my $new_tags = {};
+ my $all_tags = {};
+
+ $all_tags->{$_} = $old_tags->{$_} += 1 for PVE::Tools::split_list($tagopt_old // '');
+ $all_tags->{$_} = $new_tags->{$_} += 1 for PVE::Tools::split_list($tagopt_new // '');
+
+ for my $tag (keys $all_tags->%*) {
+ next if ($new_tags->{$tag} // 0) == ($old_tags->{$tag} // 0);
+ $check_single_tag->($tag);
+ }
+}
+
1;
--
2.30.2
next prev parent reply other threads:[~2022-11-16 15:49 UTC|newest]
Thread overview: 25+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-11-16 15:47 [pve-devel] [PATCH cluster/guest-common/qemu-server/ct/manager v11] add tags to ui Dominik Csapak
2022-11-16 15:47 ` [pve-devel] [PATCH cluster v11 1/5] add CFS_IPC_GET_GUEST_CONFIG_PROPERTIES method Dominik Csapak
2022-11-16 15:47 ` [pve-devel] [PATCH cluster v11 2/5] Cluster: add get_guest_config_properties Dominik Csapak
2022-11-16 15:47 ` [pve-devel] [PATCH cluster v11 3/5] datacenter.cfg: add option for tag-style Dominik Csapak
2022-11-16 15:47 ` [pve-devel] [PATCH cluster v11 4/5] datacenter.cfg: add tag rights control to the datacenter config Dominik Csapak
2022-11-16 15:47 ` [pve-devel] [PATCH cluster v11 5/5] datacenter.cfg: add 'ordering' to 'tag-style' config Dominik Csapak
2022-11-16 15:48 ` Dominik Csapak [this message]
2022-11-17 12:12 ` [pve-devel] applied: [PATCH guest-common v11 1/1] GuestHelpers: add tag related helpers Thomas Lamprecht
2022-11-16 15:48 ` [pve-devel] [PATCH qemu-server v11 1/1] api: update: check for tags permissions with 'assert_tag_permissions' Dominik Csapak
2022-11-16 15:48 ` [pve-devel] [PATCH container v11 1/1] check_ct_modify_config_perm: " Dominik Csapak
2022-11-16 15:48 ` [pve-devel] [PATCH manager v11 01/13] api: /cluster/resources: add tags to returned properties Dominik Csapak
2022-11-16 15:48 ` [pve-devel] [PATCH manager v11 02/13] api: allow all users to (partially) read datacenter.cfg Dominik Csapak
2022-11-16 15:48 ` [pve-devel] [PATCH manager v11 03/13] ui: save ui options from /cluster/options instead of version Dominik Csapak
2022-11-16 15:48 ` [pve-devel] [PATCH manager v11 04/13] ui: parse and save tag infos from /cluster/options Dominik Csapak
2022-11-16 15:48 ` [pve-devel] [PATCH manager v11 05/13] ui: add form/TagColorGrid Dominik Csapak
2022-11-16 15:48 ` [pve-devel] [PATCH manager v11 06/13] ui: add PVE.form.ListField Dominik Csapak
2022-11-16 15:48 ` [pve-devel] [PATCH manager v11 07/13] ui: dc/OptionView: add editors for tag settings Dominik Csapak
2022-11-16 15:48 ` [pve-devel] [PATCH manager v11 08/13] ui: add form/Tag Dominik Csapak
2022-11-16 15:48 ` [pve-devel] [PATCH manager v11 09/13] ui: add form/TagEdit.js Dominik Csapak
2022-11-16 15:48 ` [pve-devel] [PATCH manager v11 10/13] ui: {lxc, qemu}/Config: show Tags and make them editable Dominik Csapak
2022-11-16 15:48 ` [pve-devel] [PATCH manager v11 11/13] ui: tree/ResourceTree: show Tags in tree Dominik Csapak
2022-11-16 15:48 ` [pve-devel] [PATCH manager v11 12/13] ui: add tags to ResourceGrid and GlobalSearchField Dominik Csapak
2022-11-16 15:48 ` [pve-devel] [PATCH manager v11 13/13] ui: implement tag ordering from datacenter.cfg Dominik Csapak
2022-11-17 10:18 ` [pve-devel] partially-applied: [PATCH cluster/guest-common/qemu-server/ct/manager v11] add tags to ui Thomas Lamprecht
2022-11-17 17:22 ` [pve-devel] applied: " Thomas Lamprecht
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=20221116154815.358385-7-d.csapak@proxmox.com \
--to=d.csapak@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