1 package PVE
::API2
::User
;
5 use PVE
::Exception
qw(raise raise_perm_exc raise_param_exc);
6 use PVE
::Cluster qw
(cfs_read_file cfs_write_file
);
7 use PVE
::Tools
qw(split_list extract_param);
8 use PVE
::AccessControl
;
9 use PVE
::JSONSchema
qw(get_standard_option register_standard_option);
16 use base
qw(PVE::RESTHandler);
18 register_standard_option
('user-enable', {
19 description
=> "Enable the account (default). You can set this to '0' to disable the account",
24 register_standard_option
('user-expire', {
25 description
=> "Account expiration date (seconds since epoch). '0' means no expiration date.",
30 register_standard_option
('user-firstname', { type
=> 'string', optional
=> 1 });
31 register_standard_option
('user-lastname', { type
=> 'string', optional
=> 1 });
32 register_standard_option
('user-email', { type
=> 'string', optional
=> 1, format
=> 'email-opt' });
33 register_standard_option
('user-comment', { type
=> 'string', optional
=> 1 });
34 register_standard_option
('user-keys', {
35 description
=> "Keys for two factor auth (yubico).",
39 register_standard_option
('group-list', {
40 type
=> 'string', format
=> 'pve-groupid-list',
42 completion
=> \
&PVE
::AccessControl
::complete_group
,
44 register_standard_option
('token-subid', {
46 pattern
=> $PVE::AccessControl
::token_subid_regex
,
47 description
=> 'User-specific token identifier.',
49 register_standard_option
('token-expire', {
50 description
=> "API token expiration date (seconds since epoch). '0' means no expiration date.",
54 default => 'same as user',
56 register_standard_option
('token-privsep', {
57 description
=> "Restrict API token privileges with separate ACLs (default), or give full privileges of corresponding user.",
62 register_standard_option
('token-comment', { type
=> 'string', optional
=> 1 });
63 register_standard_option
('token-info', {
66 expire
=> get_standard_option
('token-expire'),
67 privsep
=> get_standard_option
('token-privsep'),
68 comment
=> get_standard_option
('token-comment'),
72 my $token_info_extend = sub {
75 my $obj = get_standard_option
('token-info');
76 my $base_props = $obj->{properties
};
77 $obj->{properties
} = {};
79 foreach my $prop (keys %$base_props) {
80 $obj->{properties
}->{$prop} = $base_props->{$prop};
83 foreach my $add_prop (keys %$props) {
84 $obj->{properties
}->{$add_prop} = $props->{$add_prop};
90 my $extract_user_data = sub {
91 my ($data, $full) = @_;
95 foreach my $prop (qw(enable expire firstname lastname email comment keys)) {
96 $res->{$prop} = $data->{$prop} if defined($data->{$prop});
99 return $res if !$full;
101 $res->{groups
} = $data->{groups
} ?
[ keys %{$data->{groups
}} ] : [];
102 $res->{tokens
} = $data->{tokens
};
107 __PACKAGE__-
>register_method ({
111 description
=> "User index.",
113 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.",
117 additionalProperties
=> 0,
121 description
=> "Optional filter for enable property.",
126 description
=> "Include group and token information.",
137 userid
=> get_standard_option
('userid-completed'),
138 enable
=> get_standard_option
('user-enable'),
139 expire
=> get_standard_option
('user-expire'),
140 firstname
=> get_standard_option
('user-firstname'),
141 lastname
=> get_standard_option
('user-lastname'),
142 email
=> get_standard_option
('user-email'),
143 comment
=> get_standard_option
('user-comment'),
144 keys => get_standard_option
('user-keys'),
145 groups
=> get_standard_option
('group-list'),
149 items
=> $token_info_extend->({
150 tokenid
=> get_standard_option
('token-subid'),
154 type
=> 'string', format
=> 'pve-realm',
155 description
=> 'The type of the users realm',
156 optional
=> 1, # it should always be there, but we use conditional code below, so..
160 links
=> [ { rel
=> 'child', href
=> "{userid}" } ],
165 my $rpcenv = PVE
::RPCEnvironment
::get
();
166 my $usercfg = $rpcenv->{user_cfg
};
167 my $authuser = $rpcenv->get_user();
169 my $domainscfg = cfs_read_file
('domains.cfg');
170 my $domainids = $domainscfg->{ids
};
174 my $privs = [ 'User.Modify', 'Sys.Audit' ];
175 my $canUserMod = $rpcenv->check_any($authuser, "/access/groups", $privs, 1);
176 my $groups = $rpcenv->filter_groups($authuser, $privs, 1);
177 my $allowed_users = $rpcenv->group_member_join([keys %$groups]);
179 foreach my $user (keys %{$usercfg->{users
}}) {
180 if (!($canUserMod || $user eq $authuser)) {
181 next if !$allowed_users->{$user};
184 my $entry = &$extract_user_data($usercfg->{users
}->{$user}, $param->{full
});
186 if (defined($param->{enabled
})) {
187 next if $entry->{enable
} && !$param->{enabled
};
188 next if !$entry->{enable
} && $param->{enabled
};
191 $entry->{groups
} = join(',', @{$entry->{groups
}}) if $entry->{groups
};
192 $entry->{tokens
} = [ map { { tokenid
=> $_, %{$entry->{tokens
}->{$_}} } } sort keys %{$entry->{tokens
}} ]
193 if defined($entry->{tokens
});
195 my (undef, undef, $realm) = PVE
::AccessControl
::verify_username
($user, 1);
196 if (defined($realm) && exists($domainids->{$realm})) {
197 $entry->{'realm-type'} = $domainids->{$realm}->{type
};
200 $entry->{userid
} = $user;
207 __PACKAGE__-
>register_method ({
208 name
=> 'create_user',
213 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.",
215 [ 'userid-param', 'Realm.AllocateUser'],
216 [ 'userid-group', ['User.Modify'], groups_param
=> 1],
219 description
=> "Create new user.",
221 additionalProperties
=> 0,
223 userid
=> get_standard_option
('userid-completed'),
224 enable
=> get_standard_option
('user-enable'),
225 expire
=> get_standard_option
('user-expire'),
226 firstname
=> get_standard_option
('user-firstname'),
227 lastname
=> get_standard_option
('user-lastname'),
228 email
=> get_standard_option
('user-email'),
229 comment
=> get_standard_option
('user-comment'),
230 keys => get_standard_option
('user-keys'),
232 description
=> "Initial password.",
238 groups
=> get_standard_option
('group-list'),
241 returns
=> { type
=> 'null' },
245 PVE
::AccessControl
::lock_user_config
(sub {
246 my ($username, $ruid, $realm) = PVE
::AccessControl
::verify_username
($param->{userid
});
248 my $usercfg = cfs_read_file
("user.cfg");
250 # ensure "user exists" check works for case insensitive realms
251 $username = PVE
::AccessControl
::lookup_username
($username, 1);
252 die "user '$username' already exists\n" if $usercfg->{users
}->{$username};
254 PVE
::AccessControl
::domain_set_password
($realm, $ruid, $param->{password
})
255 if defined($param->{password
});
257 my $enable = defined($param->{enable
}) ?
$param->{enable
} : 1;
258 $usercfg->{users
}->{$username} = { enable
=> $enable };
259 $usercfg->{users
}->{$username}->{expire
} = $param->{expire
} if $param->{expire
};
261 if ($param->{groups
}) {
262 foreach my $group (split_list
($param->{groups
})) {
263 if ($usercfg->{groups
}->{$group}) {
264 PVE
::AccessControl
::add_user_group
($username, $usercfg, $group);
266 die "no such group '$group'\n";
271 $usercfg->{users
}->{$username}->{firstname
} = $param->{firstname
} if $param->{firstname
};
272 $usercfg->{users
}->{$username}->{lastname
} = $param->{lastname
} if $param->{lastname
};
273 $usercfg->{users
}->{$username}->{email
} = $param->{email
} if $param->{email
};
274 $usercfg->{users
}->{$username}->{comment
} = $param->{comment
} if $param->{comment
};
275 $usercfg->{users
}->{$username}->{keys} = $param->{keys} if $param->{keys};
277 cfs_write_file
("user.cfg", $usercfg);
278 }, "create user failed");
283 __PACKAGE__-
>register_method ({
287 description
=> "Get user configuration.",
289 check
=> ['userid-group', ['User.Modify', 'Sys.Audit']],
292 additionalProperties
=> 0,
294 userid
=> get_standard_option
('userid-completed'),
298 additionalProperties
=> 0,
300 enable
=> get_standard_option
('user-enable'),
301 expire
=> get_standard_option
('user-expire'),
302 firstname
=> get_standard_option
('user-firstname'),
303 lastname
=> get_standard_option
('user-lastname'),
304 email
=> get_standard_option
('user-email'),
305 comment
=> get_standard_option
('user-comment'),
306 keys => get_standard_option
('user-keys'),
312 format
=> 'pve-groupid',
325 my ($username, undef, $domain) =
326 PVE
::AccessControl
::verify_username
($param->{userid
});
328 my $usercfg = cfs_read_file
("user.cfg");
330 my $data = PVE
::AccessControl
::check_user_exist
($usercfg, $username);
332 return &$extract_user_data($data, 1);
335 __PACKAGE__-
>register_method ({
336 name
=> 'update_user',
341 check
=> ['userid-group', ['User.Modify'], groups_param
=> 1 ],
343 description
=> "Update user configuration.",
345 additionalProperties
=> 0,
347 userid
=> get_standard_option
('userid-completed'),
348 enable
=> get_standard_option
('user-enable'),
349 expire
=> get_standard_option
('user-expire'),
350 firstname
=> get_standard_option
('user-firstname'),
351 lastname
=> get_standard_option
('user-lastname'),
352 email
=> get_standard_option
('user-email'),
353 comment
=> get_standard_option
('user-comment'),
354 keys => get_standard_option
('user-keys'),
355 groups
=> get_standard_option
('group-list'),
359 requires
=> 'groups',
363 returns
=> { type
=> 'null' },
367 my ($username, $ruid, $realm) =
368 PVE
::AccessControl
::verify_username
($param->{userid
});
370 PVE
::AccessControl
::lock_user_config
(
373 my $usercfg = cfs_read_file
("user.cfg");
375 PVE
::AccessControl
::check_user_exist
($usercfg, $username);
377 $usercfg->{users
}->{$username}->{enable
} = $param->{enable
} if defined($param->{enable
});
379 $usercfg->{users
}->{$username}->{expire
} = $param->{expire
} if defined($param->{expire
});
381 PVE
::AccessControl
::delete_user_group
($username, $usercfg)
382 if (!$param->{append
} && defined($param->{groups
}));
384 if ($param->{groups
}) {
385 foreach my $group (split_list
($param->{groups
})) {
386 if ($usercfg->{groups
}->{$group}) {
387 PVE
::AccessControl
::add_user_group
($username, $usercfg, $group);
389 die "no such group '$group'\n";
394 $usercfg->{users
}->{$username}->{firstname
} = $param->{firstname
} if defined($param->{firstname
});
395 $usercfg->{users
}->{$username}->{lastname
} = $param->{lastname
} if defined($param->{lastname
});
396 $usercfg->{users
}->{$username}->{email
} = $param->{email
} if defined($param->{email
});
397 $usercfg->{users
}->{$username}->{comment
} = $param->{comment
} if defined($param->{comment
});
398 $usercfg->{users
}->{$username}->{keys} = $param->{keys} if defined($param->{keys});
400 cfs_write_file
("user.cfg", $usercfg);
401 }, "update user failed");
406 __PACKAGE__-
>register_method ({
407 name
=> 'delete_user',
411 description
=> "Delete user.",
414 [ 'userid-param', 'Realm.AllocateUser'],
415 [ 'userid-group', ['User.Modify']],
419 additionalProperties
=> 0,
421 userid
=> get_standard_option
('userid-completed'),
424 returns
=> { type
=> 'null' },
428 my $rpcenv = PVE
::RPCEnvironment
::get
();
429 my $authuser = $rpcenv->get_user();
431 my ($userid, $ruid, $realm) =
432 PVE
::AccessControl
::verify_username
($param->{userid
});
434 PVE
::AccessControl
::lock_user_config
(
437 my $usercfg = cfs_read_file
("user.cfg");
439 my $domain_cfg = cfs_read_file
('domains.cfg');
440 if (my $cfg = $domain_cfg->{ids
}->{$realm}) {
441 my $plugin = PVE
::Auth
::Plugin-
>lookup($cfg->{type
});
442 $plugin->delete_user($cfg, $realm, $ruid);
445 # Remove TFA data before removing the user entry as the user entry tells us whether
446 # we need ot update priv/tfa.cfg.
447 PVE
::AccessControl
::user_set_tfa
($userid, $realm, undef, undef, $usercfg, $domain_cfg);
449 delete $usercfg->{users
}->{$userid};
451 PVE
::AccessControl
::delete_user_group
($userid, $usercfg);
452 PVE
::AccessControl
::delete_user_acl
($userid, $usercfg);
453 cfs_write_file
("user.cfg", $usercfg);
454 }, "delete user failed");
459 __PACKAGE__-
>register_method ({
460 name
=> 'read_user_tfa_type',
461 path
=> '{userid}/tfa',
464 description
=> "Get user TFA types (Personal and Realm).",
467 ['userid-param', 'self'],
468 ['userid-group', ['User.Modify', 'Sys.Audit']],
472 additionalProperties
=> 0,
474 userid
=> get_standard_option
('userid-completed'),
478 additionalProperties
=> 0,
482 enum
=> [qw(oath yubico)],
483 description
=> "The type of TFA the users realm has set, if any.",
488 enum
=> [qw(oath u2f)],
489 description
=> "The type of TFA the user has set, if any.",
498 my ($username, undef, $realm) = PVE
::AccessControl
::verify_username
($param->{userid
});
501 my $domain_cfg = cfs_read_file
('domains.cfg');
502 my $realm_cfg = $domain_cfg->{ids
}->{$realm};
503 die "auth domain '$realm' does not exist\n" if !$realm_cfg;
506 $realm_tfa = PVE
::Auth
::Plugin
::parse_tfa_config
($realm_cfg->{tfa
})
507 if $realm_cfg->{tfa
};
509 my $tfa_cfg = cfs_read_file
('priv/tfa.cfg');
510 my $tfa = $tfa_cfg->{users
}->{$username};
513 $res->{realm
} = $realm_tfa->{type
} if $realm_tfa->{type
};
514 $res->{user
} = $tfa->{type
} if $tfa->{type
};
518 __PACKAGE__-
>register_method ({
519 name
=> 'token_index',
520 path
=> '{userid}/token',
522 description
=> "Get user API tokens.",
525 ['userid-param', 'self'],
526 ['perm', '/access/users/{userid}', ['User.Modify']],
530 additionalProperties
=> 0,
532 userid
=> get_standard_option
('userid-completed'),
537 items
=> $token_info_extend->({
538 tokenid
=> get_standard_option
('token-subid'),
540 links
=> [ { rel
=> 'child', href
=> "{tokenid}" } ],
545 my $userid = PVE
::AccessControl
::verify_username
($param->{userid
});
546 my $usercfg = cfs_read_file
("user.cfg");
548 my $user = PVE
::AccessControl
::check_user_exist
($usercfg, $userid);
550 my $tokens = $user->{tokens
} // {};
551 return [ map { $tokens->{$_}->{tokenid
} = $_; $tokens->{$_} } keys %$tokens];
554 __PACKAGE__-
>register_method ({
555 name
=> 'read_token',
556 path
=> '{userid}/token/{tokenid}',
558 description
=> "Get specific API token information.",
561 ['userid-param', 'self'],
562 ['perm', '/access/users/{userid}', ['User.Modify']],
566 additionalProperties
=> 0,
568 userid
=> get_standard_option
('userid-completed'),
569 tokenid
=> get_standard_option
('token-subid'),
572 returns
=> get_standard_option
('token-info'),
576 my $userid = PVE
::AccessControl
::verify_username
($param->{userid
});
577 my $tokenid = $param->{tokenid
};
579 my $usercfg = cfs_read_file
("user.cfg");
581 return PVE
::AccessControl
::check_token_exist
($usercfg, $userid, $tokenid);
584 __PACKAGE__-
>register_method ({
585 name
=> 'generate_token',
586 path
=> '{userid}/token/{tokenid}',
588 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!",
592 ['userid-param', 'self'],
593 ['perm', '/access/users/{userid}', ['User.Modify']],
597 additionalProperties
=> 0,
599 userid
=> get_standard_option
('userid-completed'),
600 tokenid
=> get_standard_option
('token-subid'),
601 expire
=> get_standard_option
('token-expire'),
602 privsep
=> get_standard_option
('token-privsep'),
603 comment
=> get_standard_option
('token-comment'),
607 additionalProperties
=> 0,
610 info
=> get_standard_option
('token-info'),
613 description
=> 'API token value used for authentication.',
617 format_description
=> '<userid>!<tokenid>',
618 description
=> 'The full token id.',
625 my $userid = PVE
::AccessControl
::verify_username
(extract_param
($param, 'userid'));
626 my $tokenid = extract_param
($param, 'tokenid');
628 my $usercfg = cfs_read_file
("user.cfg");
630 my $token = PVE
::AccessControl
::check_token_exist
($usercfg, $userid, $tokenid, 1);
631 my ($full_tokenid, $value);
633 PVE
::AccessControl
::check_user_exist
($usercfg, $userid);
634 raise_param_exc
({ 'tokenid' => 'Token already exists.' }) if defined($token);
636 my $generate_and_add_token = sub {
637 $usercfg = cfs_read_file
("user.cfg");
638 PVE
::AccessControl
::check_user_exist
($usercfg, $userid);
639 die "Token already exists.\n" if defined(PVE
::AccessControl
::check_token_exist
($usercfg, $userid, $tokenid, 1));
641 $full_tokenid = PVE
::AccessControl
::join_tokenid
($userid, $tokenid);
642 $value = PVE
::TokenConfig
::generate_token
($full_tokenid);
645 $token->{privsep
} = defined($param->{privsep
}) ?
$param->{privsep
} : 1;
646 $token->{expire
} = $param->{expire
} if defined($param->{expire
});
647 $token->{comment
} = $param->{comment
} if $param->{comment
};
649 $usercfg->{users
}->{$userid}->{tokens
}->{$tokenid} = $token;
650 cfs_write_file
("user.cfg", $usercfg);
653 PVE
::AccessControl
::lock_user_config
($generate_and_add_token, 'generating token failed');
658 'full-tokenid' => $full_tokenid,
663 __PACKAGE__-
>register_method ({
664 name
=> 'update_token_info',
665 path
=> '{userid}/token/{tokenid}',
667 description
=> "Update API token for a specific user.",
671 ['userid-param', 'self'],
672 ['perm', '/access/users/{userid}', ['User.Modify']],
676 additionalProperties
=> 0,
678 userid
=> get_standard_option
('userid-completed'),
679 tokenid
=> get_standard_option
('token-subid'),
680 expire
=> get_standard_option
('token-expire'),
681 privsep
=> get_standard_option
('token-privsep'),
682 comment
=> get_standard_option
('token-comment'),
685 returns
=> get_standard_option
('token-info', { description
=> "Updated token information." }),
689 my $userid = PVE
::AccessControl
::verify_username
(extract_param
($param, 'userid'));
690 my $tokenid = extract_param
($param, 'tokenid');
692 my $usercfg = cfs_read_file
("user.cfg");
693 my $token = PVE
::AccessControl
::check_token_exist
($usercfg, $userid, $tokenid);
695 my $update_token = sub {
696 $usercfg = cfs_read_file
("user.cfg");
697 $token = PVE
::AccessControl
::check_token_exist
($usercfg, $userid, $tokenid);
699 my $full_tokenid = PVE
::AccessControl
::join_tokenid
($userid, $tokenid);
701 $token->{privsep
} = $param->{privsep
} if defined($param->{privsep
});
702 $token->{expire
} = $param->{expire
} if defined($param->{expire
});
703 $token->{comment
} = $param->{comment
} if $param->{comment
};
705 $usercfg->{users
}->{$userid}->{tokens
}->{$tokenid} = $token;
706 cfs_write_file
("user.cfg", $usercfg);
709 PVE
::AccessControl
::lock_user_config
($update_token, 'updating token info failed');
715 __PACKAGE__-
>register_method ({
716 name
=> 'remove_token',
717 path
=> '{userid}/token/{tokenid}',
719 description
=> "Remove API token for a specific user.",
723 ['userid-param', 'self'],
724 ['perm', '/access/users/{userid}', ['User.Modify']],
728 additionalProperties
=> 0,
730 userid
=> get_standard_option
('userid-completed'),
731 tokenid
=> get_standard_option
('token-subid'),
734 returns
=> { type
=> 'null' },
738 my $userid = PVE
::AccessControl
::verify_username
(extract_param
($param, 'userid'));
739 my $tokenid = extract_param
($param, 'tokenid');
741 my $usercfg = cfs_read_file
("user.cfg");
742 my $token = PVE
::AccessControl
::check_token_exist
($usercfg, $userid, $tokenid);
744 my $update_token = sub {
745 $usercfg = cfs_read_file
("user.cfg");
747 PVE
::AccessControl
::check_token_exist
($usercfg, $userid, $tokenid);
749 my $full_tokenid = PVE
::AccessControl
::join_tokenid
($userid, $tokenid);
750 PVE
::TokenConfig
::delete_token
($full_tokenid);
751 delete $usercfg->{users
}->{$userid}->{tokens
}->{$tokenid};
753 cfs_write_file
("user.cfg", $usercfg);
756 PVE
::AccessControl
::lock_user_config
($update_token, 'deleting token failed');