1 package PVE
::API2
::User
;
6 use PVE
::Exception
qw(raise raise_perm_exc raise_param_exc);
7 use PVE
::Cluster qw
(cfs_read_file cfs_write_file
);
8 use PVE
::Tools
qw(split_list extract_param);
9 use PVE
::JSONSchema
qw(get_standard_option register_standard_option);
12 use PVE
::AccessControl
;
13 use PVE
::Auth
::Plugin
;
18 use base
qw(PVE::RESTHandler);
20 register_standard_option
('user-enable', {
21 description
=> "Enable the account (default). You can set this to '0' to disable the account",
26 register_standard_option
('user-expire', {
27 description
=> "Account expiration date (seconds since epoch). '0' means no expiration date.",
32 register_standard_option
('user-firstname', { type
=> 'string', optional
=> 1 });
33 register_standard_option
('user-lastname', { type
=> 'string', optional
=> 1 });
34 register_standard_option
('user-email', { type
=> 'string', optional
=> 1, format
=> 'email-opt' });
35 register_standard_option
('user-comment', { type
=> 'string', optional
=> 1 });
36 register_standard_option
('user-keys', {
37 description
=> "Keys for two factor auth (yubico).",
41 register_standard_option
('group-list', {
42 type
=> 'string', format
=> 'pve-groupid-list',
44 completion
=> \
&PVE
::AccessControl
::complete_group
,
46 register_standard_option
('token-subid', {
48 pattern
=> $PVE::AccessControl
::token_subid_regex
,
49 description
=> 'User-specific token identifier.',
51 register_standard_option
('token-expire', {
52 description
=> "API token expiration date (seconds since epoch). '0' means no expiration date.",
56 default => 'same as user',
58 register_standard_option
('token-privsep', {
59 description
=> "Restrict API token privileges with separate ACLs (default), or give full privileges of corresponding user.",
64 register_standard_option
('token-comment', { type
=> 'string', optional
=> 1 });
65 register_standard_option
('token-info', {
68 expire
=> get_standard_option
('token-expire'),
69 privsep
=> get_standard_option
('token-privsep'),
70 comment
=> get_standard_option
('token-comment'),
74 my $token_info_extend = sub {
77 my $obj = get_standard_option
('token-info');
78 my $base_props = $obj->{properties
};
79 $obj->{properties
} = {};
81 foreach my $prop (keys %$base_props) {
82 $obj->{properties
}->{$prop} = $base_props->{$prop};
85 foreach my $add_prop (keys %$props) {
86 $obj->{properties
}->{$add_prop} = $props->{$add_prop};
92 my $extract_user_data = sub {
93 my ($data, $full) = @_;
97 foreach my $prop (qw(enable expire firstname lastname email comment keys)) {
98 $res->{$prop} = $data->{$prop} if defined($data->{$prop});
101 return $res if !$full;
103 $res->{groups
} = $data->{groups
} ?
[ keys %{$data->{groups
}} ] : [];
104 $res->{tokens
} = $data->{tokens
};
109 __PACKAGE__-
>register_method ({
113 description
=> "User index.",
115 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.",
119 additionalProperties
=> 0,
123 description
=> "Optional filter for enable property.",
128 description
=> "Include group and token information.",
139 userid
=> get_standard_option
('userid-completed'),
140 enable
=> get_standard_option
('user-enable'),
141 expire
=> get_standard_option
('user-expire'),
142 firstname
=> get_standard_option
('user-firstname'),
143 lastname
=> get_standard_option
('user-lastname'),
144 email
=> get_standard_option
('user-email'),
145 comment
=> get_standard_option
('user-comment'),
146 keys => get_standard_option
('user-keys'),
147 groups
=> get_standard_option
('group-list'),
151 items
=> $token_info_extend->({
152 tokenid
=> get_standard_option
('token-subid'),
156 type
=> 'string', format
=> 'pve-realm',
157 description
=> 'The type of the users realm',
158 optional
=> 1, # it should always be there, but we use conditional code below, so..
162 links
=> [ { rel
=> 'child', href
=> "{userid}" } ],
167 my $rpcenv = PVE
::RPCEnvironment
::get
();
168 my $usercfg = $rpcenv->{user_cfg
};
169 my $authuser = $rpcenv->get_user();
171 my $domainscfg = cfs_read_file
('domains.cfg');
172 my $domainids = $domainscfg->{ids
};
176 my $privs = [ 'User.Modify', 'Sys.Audit' ];
177 my $canUserMod = $rpcenv->check_any($authuser, "/access/groups", $privs, 1);
178 my $groups = $rpcenv->filter_groups($authuser, $privs, 1);
179 my $allowed_users = $rpcenv->group_member_join([keys %$groups]);
181 foreach my $user (sort keys %{$usercfg->{users
}}) {
182 if (!($canUserMod || $user eq $authuser)) {
183 next if !$allowed_users->{$user};
186 my $entry = $extract_user_data->($usercfg->{users
}->{$user}, $param->{full
});
188 if (defined($param->{enabled
})) {
189 next if $entry->{enable
} && !$param->{enabled
};
190 next if !$entry->{enable
} && $param->{enabled
};
193 $entry->{groups
} = join(',', @{$entry->{groups
}}) if $entry->{groups
};
195 if (defined(my $tokens = $entry->{tokens
})) {
197 map { { tokenid
=> $_, %{$tokens->{$_}} } } sort keys %$tokens
201 if ($user =~ /($PVE::Auth::Plugin::realm_regex)$/) {
203 $entry->{'realm-type'} = $domainids->{$realm}->{type
} if exists $domainids->{$realm};
206 $entry->{userid
} = $user;
214 __PACKAGE__-
>register_method ({
215 name
=> 'create_user',
220 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.",
222 [ 'userid-param', 'Realm.AllocateUser'],
223 [ 'userid-group', ['User.Modify'], groups_param
=> 1],
226 description
=> "Create new user.",
228 additionalProperties
=> 0,
230 userid
=> get_standard_option
('userid-completed'),
231 enable
=> get_standard_option
('user-enable'),
232 expire
=> get_standard_option
('user-expire'),
233 firstname
=> get_standard_option
('user-firstname'),
234 lastname
=> get_standard_option
('user-lastname'),
235 email
=> get_standard_option
('user-email'),
236 comment
=> get_standard_option
('user-comment'),
237 keys => get_standard_option
('user-keys'),
239 description
=> "Initial password.",
245 groups
=> get_standard_option
('group-list'),
248 returns
=> { type
=> 'null' },
252 PVE
::AccessControl
::lock_user_config
(sub {
253 my ($username, $ruid, $realm) = PVE
::AccessControl
::verify_username
($param->{userid
});
255 my $usercfg = cfs_read_file
("user.cfg");
257 # ensure "user exists" check works for case insensitive realms
258 $username = PVE
::AccessControl
::lookup_username
($username, 1);
259 die "user '$username' already exists\n" if $usercfg->{users
}->{$username};
261 PVE
::AccessControl
::domain_set_password
($realm, $ruid, $param->{password
})
262 if defined($param->{password
});
264 my $enable = defined($param->{enable
}) ?
$param->{enable
} : 1;
265 $usercfg->{users
}->{$username} = { enable
=> $enable };
266 $usercfg->{users
}->{$username}->{expire
} = $param->{expire
} if $param->{expire
};
268 if ($param->{groups
}) {
269 foreach my $group (split_list
($param->{groups
})) {
270 if ($usercfg->{groups
}->{$group}) {
271 PVE
::AccessControl
::add_user_group
($username, $usercfg, $group);
273 die "no such group '$group'\n";
278 $usercfg->{users
}->{$username}->{firstname
} = $param->{firstname
} if $param->{firstname
};
279 $usercfg->{users
}->{$username}->{lastname
} = $param->{lastname
} if $param->{lastname
};
280 $usercfg->{users
}->{$username}->{email
} = $param->{email
} if $param->{email
};
281 $usercfg->{users
}->{$username}->{comment
} = $param->{comment
} if $param->{comment
};
282 $usercfg->{users
}->{$username}->{keys} = $param->{keys} if $param->{keys};
284 cfs_write_file
("user.cfg", $usercfg);
285 }, "create user failed");
290 __PACKAGE__-
>register_method ({
294 description
=> "Get user configuration.",
296 check
=> ['userid-group', ['User.Modify', 'Sys.Audit']],
299 additionalProperties
=> 0,
301 userid
=> get_standard_option
('userid-completed'),
305 additionalProperties
=> 0,
307 enable
=> get_standard_option
('user-enable'),
308 expire
=> get_standard_option
('user-expire'),
309 firstname
=> get_standard_option
('user-firstname'),
310 lastname
=> get_standard_option
('user-lastname'),
311 email
=> get_standard_option
('user-email'),
312 comment
=> get_standard_option
('user-comment'),
313 keys => get_standard_option
('user-keys'),
319 format
=> 'pve-groupid',
332 my ($username, undef, $domain) =
333 PVE
::AccessControl
::verify_username
($param->{userid
});
335 my $usercfg = cfs_read_file
("user.cfg");
337 my $data = PVE
::AccessControl
::check_user_exist
($usercfg, $username);
339 return &$extract_user_data($data, 1);
342 __PACKAGE__-
>register_method ({
343 name
=> 'update_user',
348 check
=> ['userid-group', ['User.Modify'], groups_param
=> 1 ],
350 description
=> "Update user configuration.",
352 additionalProperties
=> 0,
354 userid
=> get_standard_option
('userid-completed'),
355 enable
=> get_standard_option
('user-enable'),
356 expire
=> get_standard_option
('user-expire'),
357 firstname
=> get_standard_option
('user-firstname'),
358 lastname
=> get_standard_option
('user-lastname'),
359 email
=> get_standard_option
('user-email'),
360 comment
=> get_standard_option
('user-comment'),
361 keys => get_standard_option
('user-keys'),
362 groups
=> get_standard_option
('group-list'),
366 requires
=> 'groups',
370 returns
=> { type
=> 'null' },
374 my ($username, $ruid, $realm) =
375 PVE
::AccessControl
::verify_username
($param->{userid
});
377 PVE
::AccessControl
::lock_user_config
(
380 my $usercfg = cfs_read_file
("user.cfg");
382 PVE
::AccessControl
::check_user_exist
($usercfg, $username);
384 $usercfg->{users
}->{$username}->{enable
} = $param->{enable
} if defined($param->{enable
});
386 $usercfg->{users
}->{$username}->{expire
} = $param->{expire
} if defined($param->{expire
});
388 PVE
::AccessControl
::delete_user_group
($username, $usercfg)
389 if (!$param->{append
} && defined($param->{groups
}));
391 if ($param->{groups
}) {
392 foreach my $group (split_list
($param->{groups
})) {
393 if ($usercfg->{groups
}->{$group}) {
394 PVE
::AccessControl
::add_user_group
($username, $usercfg, $group);
396 die "no such group '$group'\n";
401 $usercfg->{users
}->{$username}->{firstname
} = $param->{firstname
} if defined($param->{firstname
});
402 $usercfg->{users
}->{$username}->{lastname
} = $param->{lastname
} if defined($param->{lastname
});
403 $usercfg->{users
}->{$username}->{email
} = $param->{email
} if defined($param->{email
});
404 $usercfg->{users
}->{$username}->{comment
} = $param->{comment
} if defined($param->{comment
});
405 $usercfg->{users
}->{$username}->{keys} = $param->{keys} if defined($param->{keys});
407 cfs_write_file
("user.cfg", $usercfg);
408 }, "update user failed");
413 __PACKAGE__-
>register_method ({
414 name
=> 'delete_user',
418 description
=> "Delete user.",
421 [ 'userid-param', 'Realm.AllocateUser'],
422 [ 'userid-group', ['User.Modify']],
426 additionalProperties
=> 0,
428 userid
=> get_standard_option
('userid-completed'),
431 returns
=> { type
=> 'null' },
435 my $rpcenv = PVE
::RPCEnvironment
::get
();
436 my $authuser = $rpcenv->get_user();
438 my ($userid, $ruid, $realm) =
439 PVE
::AccessControl
::verify_username
($param->{userid
});
441 PVE
::AccessControl
::lock_user_config
(
444 my $usercfg = cfs_read_file
("user.cfg");
446 my $domain_cfg = cfs_read_file
('domains.cfg');
447 if (my $cfg = $domain_cfg->{ids
}->{$realm}) {
448 my $plugin = PVE
::Auth
::Plugin-
>lookup($cfg->{type
});
449 $plugin->delete_user($cfg, $realm, $ruid);
452 # Remove TFA data before removing the user entry as the user entry tells us whether
453 # we need ot update priv/tfa.cfg.
454 PVE
::AccessControl
::user_set_tfa
($userid, $realm, undef, undef, $usercfg, $domain_cfg);
456 delete $usercfg->{users
}->{$userid};
458 PVE
::AccessControl
::delete_user_group
($userid, $usercfg);
459 PVE
::AccessControl
::delete_user_acl
($userid, $usercfg);
460 cfs_write_file
("user.cfg", $usercfg);
461 }, "delete user failed");
466 __PACKAGE__-
>register_method ({
467 name
=> 'read_user_tfa_type',
468 path
=> '{userid}/tfa',
471 description
=> "Get user TFA types (Personal and Realm).",
474 ['userid-param', 'self'],
475 ['userid-group', ['User.Modify', 'Sys.Audit']],
479 additionalProperties
=> 0,
481 userid
=> get_standard_option
('userid-completed'),
485 additionalProperties
=> 0,
489 enum
=> [qw(oath yubico)],
490 description
=> "The type of TFA the users realm has set, if any.",
495 enum
=> [qw(oath u2f)],
496 description
=> "The type of TFA the user has set, if any.",
505 my ($username, undef, $realm) = PVE
::AccessControl
::verify_username
($param->{userid
});
508 my $domain_cfg = cfs_read_file
('domains.cfg');
509 my $realm_cfg = $domain_cfg->{ids
}->{$realm};
510 die "auth domain '$realm' does not exist\n" if !$realm_cfg;
513 $realm_tfa = PVE
::Auth
::Plugin
::parse_tfa_config
($realm_cfg->{tfa
})
514 if $realm_cfg->{tfa
};
516 my $tfa_cfg = cfs_read_file
('priv/tfa.cfg');
517 my $tfa = $tfa_cfg->{users
}->{$username};
520 $res->{realm
} = $realm_tfa->{type
} if $realm_tfa->{type
};
521 $res->{user
} = $tfa->{type
} if $tfa->{type
};
525 __PACKAGE__-
>register_method ({
526 name
=> 'token_index',
527 path
=> '{userid}/token',
529 description
=> "Get user API tokens.",
532 ['userid-param', 'self'],
533 ['perm', '/access/users/{userid}', ['User.Modify']],
537 additionalProperties
=> 0,
539 userid
=> get_standard_option
('userid-completed'),
544 items
=> $token_info_extend->({
545 tokenid
=> get_standard_option
('token-subid'),
547 links
=> [ { rel
=> 'child', href
=> "{tokenid}" } ],
552 my $userid = PVE
::AccessControl
::verify_username
($param->{userid
});
553 my $usercfg = cfs_read_file
("user.cfg");
555 my $user = PVE
::AccessControl
::check_user_exist
($usercfg, $userid);
557 my $tokens = $user->{tokens
} // {};
558 return [ map { $tokens->{$_}->{tokenid
} = $_; $tokens->{$_} } keys %$tokens];
561 __PACKAGE__-
>register_method ({
562 name
=> 'read_token',
563 path
=> '{userid}/token/{tokenid}',
565 description
=> "Get specific API token information.",
568 ['userid-param', 'self'],
569 ['perm', '/access/users/{userid}', ['User.Modify']],
573 additionalProperties
=> 0,
575 userid
=> get_standard_option
('userid-completed'),
576 tokenid
=> get_standard_option
('token-subid'),
579 returns
=> get_standard_option
('token-info'),
583 my $userid = PVE
::AccessControl
::verify_username
($param->{userid
});
584 my $tokenid = $param->{tokenid
};
586 my $usercfg = cfs_read_file
("user.cfg");
588 return PVE
::AccessControl
::check_token_exist
($usercfg, $userid, $tokenid);
591 __PACKAGE__-
>register_method ({
592 name
=> 'generate_token',
593 path
=> '{userid}/token/{tokenid}',
595 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!",
599 ['userid-param', 'self'],
600 ['perm', '/access/users/{userid}', ['User.Modify']],
604 additionalProperties
=> 0,
606 userid
=> get_standard_option
('userid-completed'),
607 tokenid
=> get_standard_option
('token-subid'),
608 expire
=> get_standard_option
('token-expire'),
609 privsep
=> get_standard_option
('token-privsep'),
610 comment
=> get_standard_option
('token-comment'),
614 additionalProperties
=> 0,
617 info
=> get_standard_option
('token-info'),
620 description
=> 'API token value used for authentication.',
624 format_description
=> '<userid>!<tokenid>',
625 description
=> 'The full token id.',
632 my $userid = PVE
::AccessControl
::verify_username
(extract_param
($param, 'userid'));
633 my $tokenid = extract_param
($param, 'tokenid');
635 my $usercfg = cfs_read_file
("user.cfg");
637 my $token = PVE
::AccessControl
::check_token_exist
($usercfg, $userid, $tokenid, 1);
638 my ($full_tokenid, $value);
640 PVE
::AccessControl
::check_user_exist
($usercfg, $userid);
641 raise_param_exc
({ 'tokenid' => 'Token already exists.' }) if defined($token);
643 my $generate_and_add_token = sub {
644 $usercfg = cfs_read_file
("user.cfg");
645 PVE
::AccessControl
::check_user_exist
($usercfg, $userid);
646 die "Token already exists.\n" if defined(PVE
::AccessControl
::check_token_exist
($usercfg, $userid, $tokenid, 1));
648 $full_tokenid = PVE
::AccessControl
::join_tokenid
($userid, $tokenid);
649 $value = PVE
::TokenConfig
::generate_token
($full_tokenid);
652 $token->{privsep
} = defined($param->{privsep
}) ?
$param->{privsep
} : 1;
653 $token->{expire
} = $param->{expire
} if defined($param->{expire
});
654 $token->{comment
} = $param->{comment
} if $param->{comment
};
656 $usercfg->{users
}->{$userid}->{tokens
}->{$tokenid} = $token;
657 cfs_write_file
("user.cfg", $usercfg);
660 PVE
::AccessControl
::lock_user_config
($generate_and_add_token, 'generating token failed');
665 'full-tokenid' => $full_tokenid,
670 __PACKAGE__-
>register_method ({
671 name
=> 'update_token_info',
672 path
=> '{userid}/token/{tokenid}',
674 description
=> "Update API token for a specific user.",
678 ['userid-param', 'self'],
679 ['perm', '/access/users/{userid}', ['User.Modify']],
683 additionalProperties
=> 0,
685 userid
=> get_standard_option
('userid-completed'),
686 tokenid
=> get_standard_option
('token-subid'),
687 expire
=> get_standard_option
('token-expire'),
688 privsep
=> get_standard_option
('token-privsep'),
689 comment
=> get_standard_option
('token-comment'),
692 returns
=> get_standard_option
('token-info', { description
=> "Updated token information." }),
696 my $userid = PVE
::AccessControl
::verify_username
(extract_param
($param, 'userid'));
697 my $tokenid = extract_param
($param, 'tokenid');
699 my $usercfg = cfs_read_file
("user.cfg");
700 my $token = PVE
::AccessControl
::check_token_exist
($usercfg, $userid, $tokenid);
702 my $update_token = sub {
703 $usercfg = cfs_read_file
("user.cfg");
704 $token = PVE
::AccessControl
::check_token_exist
($usercfg, $userid, $tokenid);
706 my $full_tokenid = PVE
::AccessControl
::join_tokenid
($userid, $tokenid);
708 $token->{privsep
} = $param->{privsep
} if defined($param->{privsep
});
709 $token->{expire
} = $param->{expire
} if defined($param->{expire
});
710 $token->{comment
} = $param->{comment
} if $param->{comment
};
712 $usercfg->{users
}->{$userid}->{tokens
}->{$tokenid} = $token;
713 cfs_write_file
("user.cfg", $usercfg);
716 PVE
::AccessControl
::lock_user_config
($update_token, 'updating token info failed');
722 __PACKAGE__-
>register_method ({
723 name
=> 'remove_token',
724 path
=> '{userid}/token/{tokenid}',
726 description
=> "Remove API token for a specific user.",
730 ['userid-param', 'self'],
731 ['perm', '/access/users/{userid}', ['User.Modify']],
735 additionalProperties
=> 0,
737 userid
=> get_standard_option
('userid-completed'),
738 tokenid
=> get_standard_option
('token-subid'),
741 returns
=> { type
=> 'null' },
745 my $userid = PVE
::AccessControl
::verify_username
(extract_param
($param, 'userid'));
746 my $tokenid = extract_param
($param, 'tokenid');
748 my $usercfg = cfs_read_file
("user.cfg");
749 my $token = PVE
::AccessControl
::check_token_exist
($usercfg, $userid, $tokenid);
751 my $update_token = sub {
752 $usercfg = cfs_read_file
("user.cfg");
754 PVE
::AccessControl
::check_token_exist
($usercfg, $userid, $tokenid);
756 my $full_tokenid = PVE
::AccessControl
::join_tokenid
($userid, $tokenid);
757 PVE
::TokenConfig
::delete_token
($full_tokenid);
758 delete $usercfg->{users
}->{$userid}->{tokens
}->{$tokenid};
760 cfs_write_file
("user.cfg", $usercfg);
763 PVE
::AccessControl
::lock_user_config
($update_token, 'deleting token failed');