[pve-devel] [PATCH access-control] api: role: remove role references from acl rules on role deletion

[Fiona Ebner]

Am 04.12.24 um 16:11 schrieb Daniel Kral:
> Let the API endpoint `DELETE /access/roles/{roleid}` or command
> `pveum role delete <roleid>` remove any ACL rules in the user
> configuration, which reference the removed role.
> 
> Before this change, the removal of a role has caused the role to remain
> in existing ACL rules, which referenced the removed role. Therefore, on
> each parse of the user configuration, a warning was be displayed:
> 
> user config - ignore invalid acl role '<role>'
> 

Might be good to note that the next modification of the configuration
would drop the unknown role (even if a role with the same name is
re-added right away).

> Signed-off-by: Daniel Kral <d.kral at proxmox.com>

Just a minor nit below, otherwise:

Reviewed-by: Fiona Ebner <f.ebner at proxmox.com>
Tested-by: Fiona Ebner <f.ebner at proxmox.com>

What would be really nice is to have some tests for various
add/modify/delete sequences touching user.cfg :) I don't think current
tests cover that yet.

> ---
>  src/PVE/API2/Role.pm     |  2 +-
>  src/PVE/AccessControl.pm | 23 +++++++++++++++++++++++
>  2 files changed, 24 insertions(+), 1 deletion(-)
> 
> diff --git a/src/PVE/API2/Role.pm b/src/PVE/API2/Role.pm
> index a924018..6e75a3c 100644
> --- a/src/PVE/API2/Role.pm
> +++ b/src/PVE/API2/Role.pm
> @@ -212,7 +212,7 @@ __PACKAGE__->register_method ({
>  
>  	    delete ($usercfg->{roles}->{$role});
>  
> -	    # fixme: delete role from acl?
> +	    PVE::AccessControl::delete_role_acl($role, $usercfg);
>  
>  	    cfs_write_file("user.cfg", $usercfg);
>  	}, "delete role failed");
> diff --git a/src/PVE/AccessControl.pm b/src/PVE/AccessControl.pm
> index 47f2d38..4bbbe80 100644
> --- a/src/PVE/AccessControl.pm
> +++ b/src/PVE/AccessControl.pm
> @@ -1022,6 +1022,29 @@ sub delete_group_acl {
>      iterate_acl_tree("/", $usercfg->{acl_root}, $code);
>  }
>  
> +sub delete_role_acl_for_each {

Nit: could be a private "my sub"

> +    my ($role, $acl_subjects) = @_;
> +
> +    for my $subject (sort keys %$acl_subjects) {
> +	delete ($acl_subjects->{$subject}->{$role})
> +	    if $acl_subjects->{$subject}->{$role};
> +    }
> +}
> +
> +sub delete_role_acl {
> +    my ($role, $usercfg) = @_;
> +
> +    my $code = sub {
> +	my ($path, $acl_node) = @_;
> +
> +	delete_role_acl_for_each($role, $acl_node->{groups});
> +	delete_role_acl_for_each($role, $acl_node->{users});
> +	delete_role_acl_for_each($role, $acl_node->{tokens});
> +    };
> +
> +    iterate_acl_tree("/", $usercfg->{acl_root}, $code);
> +}
> +
>  sub delete_pool_acl {
>      my ($pool, $usercfg) = @_;
>