1 package PVE
::API2
::User
;
5 use PVE
::Exception
qw(raise raise_perm_exc);
6 use PVE
::Cluster qw
(cfs_read_file cfs_write_file
);
7 use PVE
::Tools
qw(split_list);
8 use PVE
::AccessControl
;
9 use PVE
::JSONSchema
qw(get_standard_option);
15 use base
qw(PVE::RESTHandler);
17 my $extract_user_data = sub {
18 my ($data, $full) = @_;
22 foreach my $prop (qw(enable expire firstname lastname email comment keys)) {
23 $res->{$prop} = $data->{$prop} if defined($data->{$prop});
26 return $res if !$full;
28 $res->{groups
} = $data->{groups
} ?
[ keys %{$data->{groups
}} ] : [];
33 __PACKAGE__-
>register_method ({
37 description
=> "User index.",
39 description
=> "The returned list is restricted to users where you have 'User.Modify' or 'Sys.Audit' permissions on '/access/groups' or on a group the user belongs too. But it always includes the current (authenticated) user.",
43 additionalProperties
=> 0,
47 description
=> "Optional filter for enable property.",
57 userid
=> { type
=> 'string' },
60 links
=> [ { rel
=> 'child', href
=> "{userid}" } ],
65 my $rpcenv = PVE
::RPCEnvironment
::get
();
66 my $usercfg = $rpcenv->{user_cfg
};
67 my $authuser = $rpcenv->get_user();
71 my $privs = [ 'User.Modify', 'Sys.Audit' ];
72 my $canUserMod = $rpcenv->check_any($authuser, "/access/groups", $privs, 1);
73 my $groups = $rpcenv->filter_groups($authuser, $privs, 1);
74 my $allowed_users = $rpcenv->group_member_join([keys %$groups]);
76 foreach my $user (keys %{$usercfg->{users
}}) {
78 if (!($canUserMod || $user eq $authuser)) {
79 next if !$allowed_users->{$user};
82 my $entry = &$extract_user_data($usercfg->{users
}->{$user});
84 if (defined($param->{enabled
})) {
85 next if $entry->{enable
} && !$param->{enabled
};
86 next if !$entry->{enable
} && $param->{enabled
};
89 $entry->{userid
} = $user;
96 __PACKAGE__-
>register_method ({
97 name
=> 'create_user',
102 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.",
104 [ 'userid-param', 'Realm.AllocateUser'],
105 [ 'userid-group', ['User.Modify'], groups_param
=> 1],
108 description
=> "Create new user.",
110 additionalProperties
=> 0,
112 userid
=> get_standard_option
('userid'),
114 description
=> "Initial password.",
121 type
=> 'string', format
=> 'pve-groupid-list',
123 completion
=> \
&PVE
::AccessControl
::complete_group
,
125 firstname
=> { type
=> 'string', optional
=> 1 },
126 lastname
=> { type
=> 'string', optional
=> 1 },
127 email
=> { type
=> 'string', optional
=> 1, format
=> 'email-opt' },
128 comment
=> { type
=> 'string', optional
=> 1 },
130 description
=> "Keys for two factor auth (yubico).",
135 description
=> "Account expiration date (seconds since epoch). '0' means no expiration date.",
141 description
=> "Enable the account (default). You can set this to '0' to disable the accout",
148 returns
=> { type
=> 'null' },
152 PVE
::AccessControl
::lock_user_config
(
155 my ($username, $ruid, $realm) = PVE
::AccessControl
::verify_username
($param->{userid
});
157 my $usercfg = cfs_read_file
("user.cfg");
159 die "user '$username' already exists\n"
160 if $usercfg->{users
}->{$username};
162 PVE
::AccessControl
::domain_set_password
($realm, $ruid, $param->{password
})
163 if defined($param->{password
});
165 my $enable = defined($param->{enable
}) ?
$param->{enable
} : 1;
166 $usercfg->{users
}->{$username} = { enable
=> $enable };
167 $usercfg->{users
}->{$username}->{expire
} = $param->{expire
} if $param->{expire
};
169 if ($param->{groups
}) {
170 foreach my $group (split_list
($param->{groups
})) {
171 if ($usercfg->{groups
}->{$group}) {
172 PVE
::AccessControl
::add_user_group
($username, $usercfg, $group);
174 die "no such group '$group'\n";
179 $usercfg->{users
}->{$username}->{firstname
} = $param->{firstname
} if $param->{firstname
};
180 $usercfg->{users
}->{$username}->{lastname
} = $param->{lastname
} if $param->{lastname
};
181 $usercfg->{users
}->{$username}->{email
} = $param->{email
} if $param->{email
};
182 $usercfg->{users
}->{$username}->{comment
} = $param->{comment
} if $param->{comment
};
183 $usercfg->{users
}->{$username}->{keys} = $param->{keys} if $param->{keys};
185 cfs_write_file
("user.cfg", $usercfg);
186 }, "create user failed");
191 __PACKAGE__-
>register_method ({
195 description
=> "Get user configuration.",
197 check
=> ['userid-group', ['User.Modify', 'Sys.Audit']],
200 additionalProperties
=> 0,
202 userid
=> get_standard_option
('userid'),
206 additionalProperties
=> 0,
208 enable
=> { type
=> 'boolean' },
209 expire
=> { type
=> 'integer', optional
=> 1 },
210 firstname
=> { type
=> 'string', optional
=> 1 },
211 lastname
=> { type
=> 'string', optional
=> 1 },
212 email
=> { type
=> 'string', optional
=> 1 },
213 comment
=> { type
=> 'string', optional
=> 1 },
214 keys => { type
=> 'string', optional
=> 1 },
215 groups
=> { type
=> 'array' },
221 my ($username, undef, $domain) =
222 PVE
::AccessControl
::verify_username
($param->{userid
});
224 my $usercfg = cfs_read_file
("user.cfg");
226 my $data = PVE
::AccessControl
::check_user_exist
($usercfg, $username);
228 return &$extract_user_data($data, 1);
231 __PACKAGE__-
>register_method ({
232 name
=> 'update_user',
237 check
=> ['userid-group', ['User.Modify'], groups_param
=> 1 ],
239 description
=> "Update user configuration.",
241 additionalProperties
=> 0,
243 userid
=> get_standard_option
('userid', {
244 completion
=> \
&PVE
::AccessControl
::complete_username
,
247 type
=> 'string', format
=> 'pve-groupid-list',
249 completion
=> \
&PVE
::AccessControl
::complete_group
,
254 requires
=> 'groups',
257 description
=> "Enable/disable the account.",
261 firstname
=> { type
=> 'string', optional
=> 1 },
262 lastname
=> { type
=> 'string', optional
=> 1 },
263 email
=> { type
=> 'string', optional
=> 1, format
=> 'email-opt' },
264 comment
=> { type
=> 'string', optional
=> 1 },
266 description
=> "Keys for two factor auth (yubico).",
271 description
=> "Account expiration date (seconds since epoch). '0' means no expiration date.",
278 returns
=> { type
=> 'null' },
282 my ($username, $ruid, $realm) =
283 PVE
::AccessControl
::verify_username
($param->{userid
});
285 PVE
::AccessControl
::lock_user_config
(
288 my $usercfg = cfs_read_file
("user.cfg");
290 PVE
::AccessControl
::check_user_exist
($usercfg, $username);
292 $usercfg->{users
}->{$username}->{enable
} = $param->{enable
} if defined($param->{enable
});
294 $usercfg->{users
}->{$username}->{expire
} = $param->{expire
} if defined($param->{expire
});
296 PVE
::AccessControl
::delete_user_group
($username, $usercfg)
297 if (!$param->{append
} && defined($param->{groups
}));
299 if ($param->{groups
}) {
300 foreach my $group (split_list
($param->{groups
})) {
301 if ($usercfg->{groups
}->{$group}) {
302 PVE
::AccessControl
::add_user_group
($username, $usercfg, $group);
304 die "no such group '$group'\n";
309 $usercfg->{users
}->{$username}->{firstname
} = $param->{firstname
} if defined($param->{firstname
});
310 $usercfg->{users
}->{$username}->{lastname
} = $param->{lastname
} if defined($param->{lastname
});
311 $usercfg->{users
}->{$username}->{email
} = $param->{email
} if defined($param->{email
});
312 $usercfg->{users
}->{$username}->{comment
} = $param->{comment
} if defined($param->{comment
});
313 $usercfg->{users
}->{$username}->{keys} = $param->{keys} if defined($param->{keys});
315 cfs_write_file
("user.cfg", $usercfg);
316 }, "update user failed");
321 __PACKAGE__-
>register_method ({
322 name
=> 'delete_user',
326 description
=> "Delete user.",
329 [ 'userid-param', 'Realm.AllocateUser'],
330 [ 'userid-group', ['User.Modify']],
334 additionalProperties
=> 0,
336 userid
=> get_standard_option
('userid', {
337 completion
=> \
&PVE
::AccessControl
::complete_username
,
341 returns
=> { type
=> 'null' },
345 my $rpcenv = PVE
::RPCEnvironment
::get
();
346 my $authuser = $rpcenv->get_user();
348 my ($userid, $ruid, $realm) =
349 PVE
::AccessControl
::verify_username
($param->{userid
});
351 PVE
::AccessControl
::lock_user_config
(
354 my $usercfg = cfs_read_file
("user.cfg");
356 my $domain_cfg = cfs_read_file
('domains.cfg');
357 if (my $cfg = $domain_cfg->{ids
}->{$realm}) {
358 my $plugin = PVE
::Auth
::Plugin-
>lookup($cfg->{type
});
359 $plugin->delete_user($cfg, $realm, $ruid);
362 delete $usercfg->{users
}->{$userid};
364 PVE
::AccessControl
::delete_user_group
($userid, $usercfg);
365 PVE
::AccessControl
::delete_user_acl
($userid, $usercfg);
367 cfs_write_file
("user.cfg", $usercfg);
368 }, "delete user failed");