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.",
223 [ 'userid-param', 'Realm.AllocateUser'],
224 [ 'userid-group', ['User.Modify'], groups_param
=> 1],
227 description
=> "Create new user.",
229 additionalProperties
=> 0,
231 userid
=> get_standard_option
('userid-completed'),
232 enable
=> get_standard_option
('user-enable'),
233 expire
=> get_standard_option
('user-expire'),
234 firstname
=> get_standard_option
('user-firstname'),
235 lastname
=> get_standard_option
('user-lastname'),
236 email
=> get_standard_option
('user-email'),
237 comment
=> get_standard_option
('user-comment'),
238 keys => get_standard_option
('user-keys'),
240 description
=> "Initial password.",
246 groups
=> get_standard_option
('group-list'),
249 returns
=> { type
=> 'null' },
253 PVE
::AccessControl
::lock_user_config
(sub {
254 my ($username, $ruid, $realm) = PVE
::AccessControl
::verify_username
($param->{userid
});
256 my $usercfg = cfs_read_file
("user.cfg");
258 # ensure "user exists" check works for case insensitive realms
259 $username = PVE
::AccessControl
::lookup_username
($username, 1);
260 die "user '$username' already exists\n" if $usercfg->{users
}->{$username};
262 PVE
::AccessControl
::domain_set_password
($realm, $ruid, $param->{password
})
263 if defined($param->{password
});
265 my $enable = defined($param->{enable
}) ?
$param->{enable
} : 1;
266 $usercfg->{users
}->{$username} = { enable
=> $enable };
267 $usercfg->{users
}->{$username}->{expire
} = $param->{expire
} if $param->{expire
};
269 if ($param->{groups
}) {
270 foreach my $group (split_list
($param->{groups
})) {
271 if ($usercfg->{groups
}->{$group}) {
272 PVE
::AccessControl
::add_user_group
($username, $usercfg, $group);
274 die "no such group '$group'\n";
279 $usercfg->{users
}->{$username}->{firstname
} = $param->{firstname
} if $param->{firstname
};
280 $usercfg->{users
}->{$username}->{lastname
} = $param->{lastname
} if $param->{lastname
};
281 $usercfg->{users
}->{$username}->{email
} = $param->{email
} if $param->{email
};
282 $usercfg->{users
}->{$username}->{comment
} = $param->{comment
} if $param->{comment
};
283 $usercfg->{users
}->{$username}->{keys} = $param->{keys} if $param->{keys};
285 cfs_write_file
("user.cfg", $usercfg);
286 }, "create user failed");
291 __PACKAGE__-
>register_method ({
295 description
=> "Get user configuration.",
297 check
=> ['userid-group', ['User.Modify', 'Sys.Audit']],
300 additionalProperties
=> 0,
302 userid
=> get_standard_option
('userid-completed'),
306 additionalProperties
=> 0,
308 enable
=> get_standard_option
('user-enable'),
309 expire
=> get_standard_option
('user-expire'),
310 firstname
=> get_standard_option
('user-firstname'),
311 lastname
=> get_standard_option
('user-lastname'),
312 email
=> get_standard_option
('user-email'),
313 comment
=> get_standard_option
('user-comment'),
314 keys => get_standard_option
('user-keys'),
320 format
=> 'pve-groupid',
333 my ($username, undef, $domain) = 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) = PVE
::AccessControl
::verify_username
($param->{userid
});
376 PVE
::AccessControl
::lock_user_config
(sub {
377 my $usercfg = cfs_read_file
("user.cfg");
379 PVE
::AccessControl
::check_user_exist
($usercfg, $username);
381 $usercfg->{users
}->{$username}->{enable
} = $param->{enable
} if defined($param->{enable
});
382 $usercfg->{users
}->{$username}->{expire
} = $param->{expire
} if defined($param->{expire
});
384 PVE
::AccessControl
::delete_user_group
($username, $usercfg)
385 if (!$param->{append
} && defined($param->{groups
}));
387 if ($param->{groups
}) {
388 foreach my $group (split_list
($param->{groups
})) {
389 if ($usercfg->{groups
}->{$group}) {
390 PVE
::AccessControl
::add_user_group
($username, $usercfg, $group);
392 die "no such group '$group'\n";
397 $usercfg->{users
}->{$username}->{firstname
} = $param->{firstname
} if defined($param->{firstname
});
398 $usercfg->{users
}->{$username}->{lastname
} = $param->{lastname
} if defined($param->{lastname
});
399 $usercfg->{users
}->{$username}->{email
} = $param->{email
} if defined($param->{email
});
400 $usercfg->{users
}->{$username}->{comment
} = $param->{comment
} if defined($param->{comment
});
401 $usercfg->{users
}->{$username}->{keys} = $param->{keys} if defined($param->{keys});
403 cfs_write_file
("user.cfg", $usercfg);
404 }, "update user failed");
409 __PACKAGE__-
>register_method ({
410 name
=> 'delete_user',
414 description
=> "Delete user.",
417 [ 'userid-param', 'Realm.AllocateUser'],
418 [ 'userid-group', ['User.Modify']],
422 additionalProperties
=> 0,
424 userid
=> get_standard_option
('userid-completed'),
427 returns
=> { type
=> 'null' },
431 my $rpcenv = PVE
::RPCEnvironment
::get
();
432 my $authuser = $rpcenv->get_user();
434 my ($userid, $ruid, $realm) = PVE
::AccessControl
::verify_username
($param->{userid
});
436 PVE
::AccessControl
::lock_user_config
(sub {
437 my $usercfg = cfs_read_file
("user.cfg");
439 # NOTE: disable the user first (transaction like), so if (e.g.) we fail in the middle of
440 # TFA deletion the user will be still disabled and not just without TFA protection.
441 $usercfg->{users
}->{$userid}->{enable
} = 0;
442 cfs_write_file
("user.cfg", $usercfg);
444 my $domain_cfg = cfs_read_file
('domains.cfg');
445 if (my $cfg = $domain_cfg->{ids
}->{$realm}) {
446 my $plugin = PVE
::Auth
::Plugin-
>lookup($cfg->{type
});
447 $plugin->delete_user($cfg, $realm, $ruid);
450 # Remove user from cache before removing the TFA entry so realms with TFA-enforcement
451 # know that it's OK to drop any TFA entry in that case.
452 delete $usercfg->{users
}->{$userid};
454 my $partial_deletion = '';
456 PVE
::AccessControl
::user_set_tfa
($userid, $realm, undef, undef, $usercfg, $domain_cfg);
457 $partial_deletion = ' - but deleted related TFA';
459 PVE
::AccessControl
::delete_user_group
($userid, $usercfg);
460 $partial_deletion .= ', Groups';
461 PVE
::AccessControl
::delete_user_acl
($userid, $usercfg);
462 $partial_deletion .= ', ACLs';
464 cfs_write_file
("user.cfg", $usercfg);
466 die "$@$partial_deletion\n" if $@;
467 }, "delete user failed");
472 __PACKAGE__-
>register_method ({
473 name
=> 'read_user_tfa_type',
474 path
=> '{userid}/tfa',
477 description
=> "Get user TFA types (Personal and Realm).",
480 ['userid-param', 'self'],
481 ['userid-group', ['User.Modify', 'Sys.Audit']],
485 additionalProperties
=> 0,
487 userid
=> get_standard_option
('userid-completed'),
491 additionalProperties
=> 0,
495 enum
=> [qw(oath yubico)],
496 description
=> "The type of TFA the users realm has set, if any.",
501 enum
=> [qw(oath u2f)],
502 description
=> "The type of TFA the user has set, if any.",
511 my ($username, undef, $realm) = PVE
::AccessControl
::verify_username
($param->{userid
});
513 my $domain_cfg = cfs_read_file
('domains.cfg');
514 my $realm_cfg = $domain_cfg->{ids
}->{$realm};
515 die "auth domain '$realm' does not exist\n" if !$realm_cfg;
518 $realm_tfa = PVE
::Auth
::Plugin
::parse_tfa_config
($realm_cfg->{tfa
}) if $realm_cfg->{tfa
};
520 my $tfa_cfg = cfs_read_file
('priv/tfa.cfg');
521 my $tfa = $tfa_cfg->{users
}->{$username};
524 $res->{realm
} = $realm_tfa->{type
} if $realm_tfa->{type
};
525 $res->{user
} = $tfa->{type
} if $tfa->{type
};
529 __PACKAGE__-
>register_method ({
530 name
=> 'token_index',
531 path
=> '{userid}/token',
533 description
=> "Get user API tokens.",
537 ['userid-param', 'self'],
538 ['perm', '/access/users/{userid}', ['User.Modify']],
542 additionalProperties
=> 0,
544 userid
=> get_standard_option
('userid-completed'),
549 items
=> $token_info_extend->({
550 tokenid
=> get_standard_option
('token-subid'),
552 links
=> [ { rel
=> 'child', href
=> "{tokenid}" } ],
557 my $userid = PVE
::AccessControl
::verify_username
($param->{userid
});
558 my $usercfg = cfs_read_file
("user.cfg");
560 my $user = PVE
::AccessControl
::check_user_exist
($usercfg, $userid);
562 my $tokens = $user->{tokens
} // {};
563 return [ map { $tokens->{$_}->{tokenid
} = $_; $tokens->{$_} } keys %$tokens];
566 __PACKAGE__-
>register_method ({
567 name
=> 'read_token',
568 path
=> '{userid}/token/{tokenid}',
570 description
=> "Get specific API token information.",
574 ['userid-param', 'self'],
575 ['perm', '/access/users/{userid}', ['User.Modify']],
579 additionalProperties
=> 0,
581 userid
=> get_standard_option
('userid-completed'),
582 tokenid
=> get_standard_option
('token-subid'),
585 returns
=> get_standard_option
('token-info'),
589 my $userid = PVE
::AccessControl
::verify_username
($param->{userid
});
590 my $tokenid = $param->{tokenid
};
592 my $usercfg = cfs_read_file
("user.cfg");
594 return PVE
::AccessControl
::check_token_exist
($usercfg, $userid, $tokenid);
597 __PACKAGE__-
>register_method ({
598 name
=> 'generate_token',
599 path
=> '{userid}/token/{tokenid}',
601 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!",
606 ['userid-param', 'self'],
607 ['perm', '/access/users/{userid}', ['User.Modify']],
611 additionalProperties
=> 0,
613 userid
=> get_standard_option
('userid-completed'),
614 tokenid
=> get_standard_option
('token-subid'),
615 expire
=> get_standard_option
('token-expire'),
616 privsep
=> get_standard_option
('token-privsep'),
617 comment
=> get_standard_option
('token-comment'),
621 additionalProperties
=> 0,
624 info
=> get_standard_option
('token-info'),
627 description
=> 'API token value used for authentication.',
631 format_description
=> '<userid>!<tokenid>',
632 description
=> 'The full token id.',
639 my $userid = PVE
::AccessControl
::verify_username
(extract_param
($param, 'userid'));
640 my $tokenid = extract_param
($param, 'tokenid');
642 my $usercfg = cfs_read_file
("user.cfg");
644 my $token = PVE
::AccessControl
::check_token_exist
($usercfg, $userid, $tokenid, 1);
645 my ($full_tokenid, $value);
647 PVE
::AccessControl
::check_user_exist
($usercfg, $userid);
648 raise_param_exc
({ 'tokenid' => 'Token already exists.' }) if defined($token);
650 my $generate_and_add_token = sub {
651 $usercfg = cfs_read_file
("user.cfg");
652 PVE
::AccessControl
::check_user_exist
($usercfg, $userid);
653 die "Token already exists.\n" if defined(PVE
::AccessControl
::check_token_exist
($usercfg, $userid, $tokenid, 1));
655 $full_tokenid = PVE
::AccessControl
::join_tokenid
($userid, $tokenid);
656 $value = PVE
::TokenConfig
::generate_token
($full_tokenid);
659 $token->{privsep
} = defined($param->{privsep
}) ?
$param->{privsep
} : 1;
660 $token->{expire
} = $param->{expire
} if defined($param->{expire
});
661 $token->{comment
} = $param->{comment
} if $param->{comment
};
663 $usercfg->{users
}->{$userid}->{tokens
}->{$tokenid} = $token;
664 cfs_write_file
("user.cfg", $usercfg);
667 PVE
::AccessControl
::lock_user_config
($generate_and_add_token, 'generating token failed');
672 'full-tokenid' => $full_tokenid,
677 __PACKAGE__-
>register_method ({
678 name
=> 'update_token_info',
679 path
=> '{userid}/token/{tokenid}',
681 description
=> "Update API token for a specific user.",
686 ['userid-param', 'self'],
687 ['perm', '/access/users/{userid}', ['User.Modify']],
691 additionalProperties
=> 0,
693 userid
=> get_standard_option
('userid-completed'),
694 tokenid
=> get_standard_option
('token-subid'),
695 expire
=> get_standard_option
('token-expire'),
696 privsep
=> get_standard_option
('token-privsep'),
697 comment
=> get_standard_option
('token-comment'),
700 returns
=> get_standard_option
('token-info', { description
=> "Updated token information." }),
704 my $userid = PVE
::AccessControl
::verify_username
(extract_param
($param, 'userid'));
705 my $tokenid = extract_param
($param, 'tokenid');
707 my $usercfg = cfs_read_file
("user.cfg");
708 my $token = PVE
::AccessControl
::check_token_exist
($usercfg, $userid, $tokenid);
710 PVE
::AccessControl
::lock_user_config
(sub {
711 $usercfg = cfs_read_file
("user.cfg");
712 $token = PVE
::AccessControl
::check_token_exist
($usercfg, $userid, $tokenid);
714 my $full_tokenid = PVE
::AccessControl
::join_tokenid
($userid, $tokenid);
716 $token->{privsep
} = $param->{privsep
} if defined($param->{privsep
});
717 $token->{expire
} = $param->{expire
} if defined($param->{expire
});
718 $token->{comment
} = $param->{comment
} if $param->{comment
};
720 $usercfg->{users
}->{$userid}->{tokens
}->{$tokenid} = $token;
721 cfs_write_file
("user.cfg", $usercfg);
722 }, 'updating token info failed');
728 __PACKAGE__-
>register_method ({
729 name
=> 'remove_token',
730 path
=> '{userid}/token/{tokenid}',
732 description
=> "Remove API token for a specific user.",
737 ['userid-param', 'self'],
738 ['perm', '/access/users/{userid}', ['User.Modify']],
742 additionalProperties
=> 0,
744 userid
=> get_standard_option
('userid-completed'),
745 tokenid
=> get_standard_option
('token-subid'),
748 returns
=> { type
=> 'null' },
752 my $userid = PVE
::AccessControl
::verify_username
(extract_param
($param, 'userid'));
753 my $tokenid = extract_param
($param, 'tokenid');
755 my $usercfg = cfs_read_file
("user.cfg");
756 my $token = PVE
::AccessControl
::check_token_exist
($usercfg, $userid, $tokenid);
758 PVE
::AccessControl
::lock_user_config
(sub {
759 $usercfg = cfs_read_file
("user.cfg");
761 PVE
::AccessControl
::check_token_exist
($usercfg, $userid, $tokenid);
763 my $full_tokenid = PVE
::AccessControl
::join_tokenid
($userid, $tokenid);
764 PVE
::TokenConfig
::delete_token
($full_tokenid);
765 delete $usercfg->{users
}->{$userid}->{tokens
}->{$tokenid};
767 cfs_write_file
("user.cfg", $usercfg);
768 }, 'deleting token failed');