]> git.proxmox.com Git - pve-access-control.git/blobdiff - src/PVE/API2/User.pm
api: user: indentation & whitspace cleanups
[pve-access-control.git] / src / PVE / API2 / User.pm
index 05de57f37d4155078b30cfd646bb7457732a5940..0a38e38d4d64ea9587bf9b1e07a203fe03c5367d 100644 (file)
@@ -2,15 +2,17 @@ package PVE::API2::User;
 
 use strict;
 use warnings;
+
 use PVE::Exception qw(raise raise_perm_exc raise_param_exc);
 use PVE::Cluster qw (cfs_read_file cfs_write_file);
 use PVE::Tools qw(split_list extract_param);
-use PVE::AccessControl;
 use PVE::JSONSchema qw(get_standard_option register_standard_option);
-use PVE::TokenConfig;
-
 use PVE::SafeSyslog;
 
+use PVE::AccessControl;
+use PVE::Auth::Plugin;
+use PVE::TokenConfig;
+
 use PVE::RESTHandler;
 
 use base qw(PVE::RESTHandler);
@@ -149,7 +151,12 @@ __PACKAGE__->register_method ({
                    items => $token_info_extend->({
                        tokenid => get_standard_option('token-subid'),
                    }),
-               }
+               },
+               'realm-type' => {
+                   type => 'string', format => 'pve-realm',
+                   description => 'The type of the users realm',
+                   optional => 1, # it should always be there, but we use conditional code below, so..
+               },
            },
        },
        links => [ { rel => 'child', href => "{userid}" } ],
@@ -161,6 +168,9 @@ __PACKAGE__->register_method ({
        my $usercfg = $rpcenv->{user_cfg};
        my $authuser = $rpcenv->get_user();
 
+       my $domainscfg = cfs_read_file('domains.cfg');
+       my $domainids = $domainscfg->{ids};
+
        my $res = [];
 
        my $privs = [ 'User.Modify', 'Sys.Audit' ];
@@ -168,12 +178,12 @@ __PACKAGE__->register_method ({
        my $groups = $rpcenv->filter_groups($authuser, $privs, 1);
        my $allowed_users = $rpcenv->group_member_join([keys %$groups]);
 
-       foreach my $user (keys %{$usercfg->{users}}) {
+       foreach my $user (sort keys %{$usercfg->{users}}) {
            if (!($canUserMod || $user eq $authuser)) {
                next if !$allowed_users->{$user};
            }
 
-           my $entry = &$extract_user_data($usercfg->{users}->{$user}, $param->{full});
+           my $entry = $extract_user_data->($usercfg->{users}->{$user}, $param->{full});
 
            if (defined($param->{enabled})) {
                next if $entry->{enable} && !$param->{enabled};
@@ -181,10 +191,20 @@ __PACKAGE__->register_method ({
            }
 
            $entry->{groups} = join(',', @{$entry->{groups}}) if $entry->{groups};
-           $entry->{tokens} = [ map { { tokenid => $_, %{$entry->{tokens}->{$_}} } } sort keys %{$entry->{tokens}} ]
-               if defined($entry->{tokens});
+
+           if (defined(my $tokens = $entry->{tokens})) {
+               $entry->{tokens} = [
+                   map { { tokenid => $_, %{$tokens->{$_}} } } sort keys %$tokens
+               ];
+           }
+
+           if ($user =~ /($PVE::Auth::Plugin::realm_regex)$/) {
+               my $realm = $1;
+               $entry->{'realm-type'} = $domainids->{$realm}->{type} if exists $domainids->{$realm};
+           }
 
            $entry->{userid} = $user;
+
            push @$res, $entry;
        }
 
@@ -198,10 +218,11 @@ __PACKAGE__->register_method ({
     method => 'POST',
     permissions => {
        description => "You need 'Realm.AllocateUser' on '/access/realm/<realm>' on the realm of user <userid>, and 'User.Modify' permissions to '/access/groups/<group>' for any group specified (or 'User.Modify' on '/access/groups' if you pass no groups.",
-       check => [ 'and',
-                  [ 'userid-param', 'Realm.AllocateUser'],
-                  [ 'userid-group', ['User.Modify'], groups_param => 1],
-           ],
+       check => [
+           'and',
+           [ 'userid-param', 'Realm.AllocateUser'],
+           [ 'userid-group', ['User.Modify'], groups_param => 1],
+       ],
     },
     description => "Create new user.",
     parameters => {
@@ -309,8 +330,7 @@ __PACKAGE__->register_method ({
     code => sub {
        my ($param) = @_;
 
-       my ($username, undef, $domain) =
-           PVE::AccessControl::verify_username($param->{userid});
+       my ($username, undef, $domain) = PVE::AccessControl::verify_username($param->{userid});
 
        my $usercfg = cfs_read_file("user.cfg");
 
@@ -351,41 +371,37 @@ __PACKAGE__->register_method ({
     code => sub {
        my ($param) = @_;
 
-       my ($username, $ruid, $realm) =
-           PVE::AccessControl::verify_username($param->{userid});
-
-       PVE::AccessControl::lock_user_config(
-           sub {
+       my ($username, $ruid, $realm) = PVE::AccessControl::verify_username($param->{userid});
 
-               my $usercfg = cfs_read_file("user.cfg");
-
-               PVE::AccessControl::check_user_exist($usercfg, $username);
+       PVE::AccessControl::lock_user_config(sub {
+           my $usercfg = cfs_read_file("user.cfg");
 
-               $usercfg->{users}->{$username}->{enable} = $param->{enable} if defined($param->{enable});
+           PVE::AccessControl::check_user_exist($usercfg, $username);
 
-               $usercfg->{users}->{$username}->{expire} = $param->{expire} if defined($param->{expire});
+           $usercfg->{users}->{$username}->{enable} = $param->{enable} if defined($param->{enable});
+           $usercfg->{users}->{$username}->{expire} = $param->{expire} if defined($param->{expire});
 
-               PVE::AccessControl::delete_user_group($username, $usercfg)
-                   if (!$param->{append} && defined($param->{groups}));
+           PVE::AccessControl::delete_user_group($username, $usercfg)
+               if (!$param->{append} && defined($param->{groups}));
 
-               if ($param->{groups}) {
-                   foreach my $group (split_list($param->{groups})) {
-                       if ($usercfg->{groups}->{$group}) {
-                           PVE::AccessControl::add_user_group($username, $usercfg, $group);
-                       } else {
-                           die "no such group '$group'\n";
-                       }
+           if ($param->{groups}) {
+               foreach my $group (split_list($param->{groups})) {
+                   if ($usercfg->{groups}->{$group}) {
+                       PVE::AccessControl::add_user_group($username, $usercfg, $group);
+                   } else {
+                       die "no such group '$group'\n";
                    }
                }
+           }
 
-               $usercfg->{users}->{$username}->{firstname} = $param->{firstname} if defined($param->{firstname});
-               $usercfg->{users}->{$username}->{lastname} = $param->{lastname} if defined($param->{lastname});
-               $usercfg->{users}->{$username}->{email} = $param->{email} if defined($param->{email});
-               $usercfg->{users}->{$username}->{comment} = $param->{comment} if defined($param->{comment});
-               $usercfg->{users}->{$username}->{keys} = $param->{keys} if defined($param->{keys});
+           $usercfg->{users}->{$username}->{firstname} = $param->{firstname} if defined($param->{firstname});
+           $usercfg->{users}->{$username}->{lastname} = $param->{lastname} if defined($param->{lastname});
+           $usercfg->{users}->{$username}->{email} = $param->{email} if defined($param->{email});
+           $usercfg->{users}->{$username}->{comment} = $param->{comment} if defined($param->{comment});
+           $usercfg->{users}->{$username}->{keys} = $param->{keys} if defined($param->{keys});
 
-               cfs_write_file("user.cfg", $usercfg);
-           }, "update user failed");
+           cfs_write_file("user.cfg", $usercfg);
+       }, "update user failed");
 
        return undef;
     }});
@@ -398,9 +414,9 @@ __PACKAGE__->register_method ({
     description => "Delete user.",
     permissions => {
        check => [ 'and',
-                  [ 'userid-param', 'Realm.AllocateUser'],
-                  [ 'userid-group', ['User.Modify']],
-           ],
+           [ 'userid-param', 'Realm.AllocateUser'],
+           [ 'userid-group', ['User.Modify']],
+       ],
     },
     parameters => {
        additionalProperties => 0,
@@ -415,30 +431,27 @@ __PACKAGE__->register_method ({
        my $rpcenv = PVE::RPCEnvironment::get();
        my $authuser = $rpcenv->get_user();
 
-       my ($userid, $ruid, $realm) =
-           PVE::AccessControl::verify_username($param->{userid});
+       my ($userid, $ruid, $realm) = PVE::AccessControl::verify_username($param->{userid});
 
-       PVE::AccessControl::lock_user_config(
-           sub {
-
-               my $usercfg = cfs_read_file("user.cfg");
+       PVE::AccessControl::lock_user_config(sub {
+           my $usercfg = cfs_read_file("user.cfg");
 
-               my $domain_cfg = cfs_read_file('domains.cfg');
-               if (my $cfg = $domain_cfg->{ids}->{$realm}) {
-                   my $plugin = PVE::Auth::Plugin->lookup($cfg->{type});
-                   $plugin->delete_user($cfg, $realm, $ruid);
-               }
+           my $domain_cfg = cfs_read_file('domains.cfg');
+           if (my $cfg = $domain_cfg->{ids}->{$realm}) {
+               my $plugin = PVE::Auth::Plugin->lookup($cfg->{type});
+               $plugin->delete_user($cfg, $realm, $ruid);
+           }
 
-               # Remove TFA data before removing the user entry as the user entry tells us whether
-               # we need ot update priv/tfa.cfg.
-               PVE::AccessControl::user_set_tfa($userid, $realm, undef, undef, $usercfg, $domain_cfg);
+           # Remove TFA data before removing the user entry as the user entry tells us whether
+           # we need ot update priv/tfa.cfg.
+           PVE::AccessControl::user_set_tfa($userid, $realm, undef, undef, $usercfg, $domain_cfg);
 
-               delete $usercfg->{users}->{$userid};
+           delete $usercfg->{users}->{$userid};
 
-               PVE::AccessControl::delete_user_group($userid, $usercfg);
-               PVE::AccessControl::delete_user_acl($userid, $usercfg);
-               cfs_write_file("user.cfg", $usercfg);
-           }, "delete user failed");
+           PVE::AccessControl::delete_user_group($userid, $usercfg);
+           PVE::AccessControl::delete_user_acl($userid, $usercfg);
+           cfs_write_file("user.cfg", $usercfg);
+       }, "delete user failed");
 
        return undef;
     }});
@@ -484,14 +497,12 @@ __PACKAGE__->register_method ({
 
        my ($username, undef, $realm) = PVE::AccessControl::verify_username($param->{userid});
 
-
        my $domain_cfg = cfs_read_file('domains.cfg');
        my $realm_cfg = $domain_cfg->{ids}->{$realm};
        die "auth domain '$realm' does not exist\n" if !$realm_cfg;
 
        my $realm_tfa = {};
-       $realm_tfa = PVE::Auth::Plugin::parse_tfa_config($realm_cfg->{tfa})
-           if $realm_cfg->{tfa};
+       $realm_tfa = PVE::Auth::Plugin::parse_tfa_config($realm_cfg->{tfa}) if $realm_cfg->{tfa};
 
        my $tfa_cfg = cfs_read_file('priv/tfa.cfg');
        my $tfa = $tfa_cfg->{users}->{$username};
@@ -508,9 +519,10 @@ __PACKAGE__->register_method ({
     method => 'GET',
     description => "Get user API tokens.",
     permissions => {
-       check => ['or',
-                   ['userid-param', 'self'],
-                   ['perm', '/access/users/{userid}', ['User.Modify']],
+       check => [
+           'or',
+           ['userid-param', 'self'],
+           ['perm', '/access/users/{userid}', ['User.Modify']],
        ],
     },
     parameters => {
@@ -544,9 +556,10 @@ __PACKAGE__->register_method ({
     method => 'GET',
     description => "Get specific API token information.",
     permissions => {
-       check => ['or',
-                   ['userid-param', 'self'],
-                   ['perm', '/access/users/{userid}', ['User.Modify']],
+       check => [
+           'or',
+           ['userid-param', 'self'],
+           ['perm', '/access/users/{userid}', ['User.Modify']],
        ],
     },
     parameters => {
@@ -575,9 +588,10 @@ __PACKAGE__->register_method ({
     description => "Generate a new API token for a specific user. NOTE: returns API token value, which needs to be stored as it cannot be retrieved afterwards!",
     protected => 1,
     permissions => {
-       check => ['or',
-                   ['userid-param', 'self'],
-                   ['perm', '/access/users/{userid}', ['User.Modify']],
+       check => [
+           'or',
+           ['userid-param', 'self'],
+           ['perm', '/access/users/{userid}', ['User.Modify']],
        ],
     },
     parameters => {
@@ -654,9 +668,10 @@ __PACKAGE__->register_method ({
     description => "Update API token for a specific user.",
     protected => 1,
     permissions => {
-       check => ['or',
-                   ['userid-param', 'self'],
-                   ['perm', '/access/users/{userid}', ['User.Modify']],
+       check => [
+           'or',
+           ['userid-param', 'self'],
+           ['perm', '/access/users/{userid}', ['User.Modify']],
        ],
     },
     parameters => {
@@ -679,7 +694,7 @@ __PACKAGE__->register_method ({
        my $usercfg = cfs_read_file("user.cfg");
        my $token = PVE::AccessControl::check_token_exist($usercfg, $userid, $tokenid);
 
-       my $update_token = sub {
+       PVE::AccessControl::lock_user_config(sub {
            $usercfg = cfs_read_file("user.cfg");
            $token = PVE::AccessControl::check_token_exist($usercfg, $userid, $tokenid);
 
@@ -691,9 +706,7 @@ __PACKAGE__->register_method ({
 
            $usercfg->{users}->{$userid}->{tokens}->{$tokenid} = $token;
            cfs_write_file("user.cfg", $usercfg);
-       };
-
-       PVE::AccessControl::lock_user_config($update_token, 'updating token info failed');
+       }, 'updating token info failed');
 
        return $token;
     }});
@@ -706,9 +719,10 @@ __PACKAGE__->register_method ({
     description => "Remove API token for a specific user.",
     protected => 1,
     permissions => {
-       check => ['or',
-                   ['userid-param', 'self'],
-                   ['perm', '/access/users/{userid}', ['User.Modify']],
+       check => [
+           'or',
+           ['userid-param', 'self'],
+           ['perm', '/access/users/{userid}', ['User.Modify']],
        ],
     },
     parameters => {
@@ -728,7 +742,7 @@ __PACKAGE__->register_method ({
        my $usercfg = cfs_read_file("user.cfg");
        my $token = PVE::AccessControl::check_token_exist($usercfg, $userid, $tokenid);
 
-       my $update_token = sub {
+       PVE::AccessControl::lock_user_config(sub {
            $usercfg = cfs_read_file("user.cfg");
 
            PVE::AccessControl::check_token_exist($usercfg, $userid, $tokenid);
@@ -738,9 +752,7 @@ __PACKAGE__->register_method ({
            delete $usercfg->{users}->{$userid}->{tokens}->{$tokenid};
 
            cfs_write_file("user.cfg", $usercfg);
-       };
-
-       PVE::AccessControl::lock_user_config($update_token, 'deleting token failed');
+       }, 'deleting token failed');
 
        return;
     }});