1 package PVE
::API2
::AccessControl
;
9 use PVE
::Exception
qw(raise raise_perm_exc raise_param_exc);
11 use PVE
::RPCEnvironment
;
12 use PVE
::Cluster
qw(cfs_read_file);
13 use PVE
::DataCenterConfig
;
15 use PVE
::AccessControl
;
16 use PVE
::JSONSchema
qw(get_standard_option);
17 use PVE
::API2
::Domains
;
22 use PVE
::API2
::OpenId
;
24 use PVE
::Auth
::Plugin
;
27 my $u2f_available = 0;
33 use base
qw(PVE::RESTHandler);
35 __PACKAGE__-
>register_method ({
36 subclass
=> "PVE::API2::User",
40 __PACKAGE__-
>register_method ({
41 subclass
=> "PVE::API2::Group",
45 __PACKAGE__-
>register_method ({
46 subclass
=> "PVE::API2::Role",
50 __PACKAGE__-
>register_method ({
51 subclass
=> "PVE::API2::ACL",
55 __PACKAGE__-
>register_method ({
56 subclass
=> "PVE::API2::Domains",
60 __PACKAGE__-
>register_method ({
61 subclass
=> "PVE::API2::OpenId",
65 __PACKAGE__-
>register_method ({
66 subclass
=> "PVE::API2::TFA",
70 __PACKAGE__-
>register_method ({
74 description
=> "Directory index.",
79 additionalProperties
=> 0,
87 subdir
=> { type
=> 'string' },
90 links
=> [ { rel
=> 'child', href
=> "{subdir}" } ],
97 my $ma = __PACKAGE__-
>method_attributes();
99 foreach my $info (@$ma) {
100 next if !$info->{subclass
};
102 my $subpath = $info->{match_re
}->[0];
104 push @$res, { subdir
=> $subpath };
107 push @$res, { subdir
=> 'ticket' };
108 push @$res, { subdir
=> 'password' };
114 my sub verify_auth
: prototype($$$$$$$) {
115 my ($rpcenv, $username, $pw_or_ticket, $otp, $path, $privs, $new_format) = @_;
117 my $normpath = PVE
::AccessControl
::normalize_path
($path);
120 if (($ticketuser = PVE
::AccessControl
::verify_ticket
($pw_or_ticket, 1)) &&
121 ($ticketuser eq $username)) {
123 } elsif (PVE
::AccessControl
::verify_vnc_ticket
($pw_or_ticket, $username, $normpath, 1)) {
126 $username = PVE
::AccessControl
::authenticate_user
(
134 my $privlist = [ PVE
::Tools
::split_list
($privs) ];
135 if (!($normpath && scalar(@$privlist) && $rpcenv->check($username, $normpath, $privlist))) {
136 die "no permission ($path, $privs)\n";
139 return { username
=> $username };
142 my sub create_ticket_do
: prototype($$$$$$) {
143 my ($rpcenv, $username, $pw_or_ticket, $otp, $new_format, $tfa_challenge) = @_;
145 die "TFA response should be in 'password', not 'otp' when 'tfa-challenge' is set\n"
146 if defined($otp) && defined($tfa_challenge);
148 my ($ticketuser, undef, $tfa_info);
149 if (!defined($tfa_challenge)) {
150 # We only verify this ticket if we're not responding to a TFA challenge, as in that case
151 # it is a TFA-data ticket and will be verified by `authenticate_user`.
153 ($ticketuser, undef, $tfa_info) = PVE
::AccessControl
::verify_ticket
($pw_or_ticket, 1);
156 if (defined($ticketuser) && ($ticketuser eq 'root@pam' || $ticketuser eq $username)) {
157 if (defined($tfa_info)) {
158 die "incomplete ticket\n";
160 # valid ticket. Note: root@pam can create tickets for other users
162 ($username, $tfa_info) = PVE
::AccessControl
::authenticate_user
(
172 my $ticket_data = $username;
175 if (defined($tfa_info)) {
177 $ticket_data = "!tfa!$tfa_info";
180 } elsif (defined($tfa_info)) {
182 if ($tfa_info->{type
} eq 'u2f') {
183 my $u2finfo = $tfa_info->{data
};
184 my $u2f = get_u2f_instance
($rpcenv, $u2finfo->@{qw(publicKey keyHandle)});
185 my $challenge = $u2f->auth_challenge()
186 or die "failed to get u2f challenge\n";
187 $challenge = decode_json
($challenge);
188 $extra{U2FChallenge
} = $challenge;
189 $ticket_data = "u2f!$username!$challenge->{challenge}";
191 # General half-login / 'missing 2nd factor' ticket:
192 $ticket_data = "tfa!$username";
196 my $ticket = PVE
::AccessControl
::assemble_ticket
($ticket_data, $aad);
197 my $csrftoken = PVE
::AccessControl
::assemble_csrf_prevention_token
($username);
201 username
=> $username,
202 CSRFPreventionToken
=> $csrftoken,
207 __PACKAGE__-
>register_method ({
208 name
=> 'get_ticket',
211 permissions
=> { user
=> 'world' },
212 description
=> "Dummy. Useful for formatters which want to provide a login page.",
214 additionalProperties
=> 0,
216 returns
=> { type
=> "null" },
217 code
=> sub { return undef; }});
219 __PACKAGE__-
>register_method ({
220 name
=> 'create_ticket',
224 description
=> "You need to pass valid credientials.",
227 protected
=> 1, # else we can't access shadow files
228 allowtoken
=> 0, # we don't want tokens to create tickets
229 description
=> "Create or verify authentication ticket.",
231 additionalProperties
=> 0,
234 description
=> "User name",
237 completion
=> \
&PVE
::AccessControl
::complete_username
,
239 realm
=> get_standard_option
('realm', {
240 description
=> "You can optionally pass the realm using this parameter. Normally the realm is simply added to the username <username>\@<relam>.",
242 completion
=> \
&PVE
::AccessControl
::complete_realm
,
245 description
=> "The secret password. This can also be a valid ticket.",
249 description
=> "One-time password for Two-factor authentication.",
254 description
=> "Verify ticket, and check if user have access 'privs' on 'path'",
261 description
=> "Verify ticket, and check if user have access 'privs' on 'path'",
262 type
=> 'string' , format
=> 'pve-priv-list',
270 'With webauthn the format of half-authenticated tickts changed.'
271 .' New clients should pass 1 here and not worry about the old format.'
272 .' The old format is deprecated and will be retired with PVE-8.0',
278 description
=> "The signed TFA challenge string the user wants to respond to.",
286 username
=> { type
=> 'string' },
287 ticket
=> { type
=> 'string', optional
=> 1},
288 CSRFPreventionToken
=> { type
=> 'string', optional
=> 1 },
289 clustername
=> { type
=> 'string', optional
=> 1 },
290 # cap => computed api permissions, unless there's a u2f challenge
296 my $username = $param->{username
};
297 $username .= "\@$param->{realm}" if $param->{realm
};
299 $username = PVE
::AccessControl
::lookup_username
($username);
300 my $rpcenv = PVE
::RPCEnvironment
::get
();
304 # test if user exists and is enabled
305 $rpcenv->check_user_enabled($username);
307 if ($param->{path
} && $param->{privs
}) {
308 $res = verify_auth
($rpcenv, $username, $param->{password
}, $param->{otp
},
309 $param->{path
}, $param->{privs
}, $param->{'new-format'});
311 $res = create_ticket_do
(
316 $param->{'new-format'},
317 $param->{'tfa-challenge'},
322 my $clientip = $rpcenv->get_client_ip() || '';
323 syslog
('err', "authentication failure; rhost=$clientip user=$username msg=$err");
324 # do not return any info to prevent user enumeration attacks
325 die PVE
::Exception-
>new("authentication failure\n", code
=> 401);
328 $res->{cap
} = $rpcenv->compute_api_permission($username)
329 if !defined($res->{NeedTFA
});
331 my $clinfo = PVE
::Cluster
::get_clinfo
();
332 if ($clinfo->{cluster
}->{name
} && $rpcenv->check($username, '/', ['Sys.Audit'], 1)) {
333 $res->{clustername
} = $clinfo->{cluster
}->{name
};
336 PVE
::Cluster
::log_msg
('info', 'root@pam', "successful auth for user '$username'");
341 __PACKAGE__-
>register_method ({
342 name
=> 'change_password',
346 description
=> "Each user is allowed to change his own password. A user can change the password of another user if he has 'Realm.AllocateUser' (on the realm of user <userid>) and 'User.Modify' permission on /access/groups/<group> on a group where user <userid> is member of.",
348 ['userid-param', 'self'],
350 [ 'userid-param', 'Realm.AllocateUser'],
351 [ 'userid-group', ['User.Modify']]
355 protected
=> 1, # else we can't access shadow files
356 allowtoken
=> 0, # we don't want tokens to change the regular user password
357 description
=> "Change user password.",
359 additionalProperties
=> 0,
361 userid
=> get_standard_option
('userid-completed'),
363 description
=> "The new password.",
370 returns
=> { type
=> "null" },
374 my $rpcenv = PVE
::RPCEnvironment
::get
();
375 my $authuser = $rpcenv->get_user();
377 my ($userid, $ruid, $realm) = PVE
::AccessControl
::verify_username
($param->{userid
});
379 $rpcenv->check_user_exist($userid);
381 if ($authuser eq 'root@pam') {
382 # OK - root can change anything
384 if ($authuser eq $userid) {
385 $rpcenv->check_user_enabled($userid);
386 # OK - each user can change its own password
388 # only root may change root password
389 raise_perm_exc
() if $userid eq 'root@pam';
390 # do not allow to change system user passwords
391 raise_perm_exc
() if $realm eq 'pam';
395 PVE
::AccessControl
::domain_set_password
($realm, $ruid, $param->{password
});
397 PVE
::Cluster
::log_msg
('info', 'root@pam', "changed password for user '$userid'");
402 sub get_u2f_config
() {
403 die "u2f support not available\n" if !$u2f_available;
405 my $dc = cfs_read_file
('datacenter.cfg');
406 my $u2f = $dc->{u2f
};
407 die "u2f not configured in datacenter.cfg\n" if !$u2f;
411 sub get_u2f_instance
{
412 my ($rpcenv, $publicKey, $keyHandle) = @_;
414 # We store the public key base64 encoded (as the api provides it in binary)
415 $publicKey = decode_base64
($publicKey) if defined($publicKey);
417 my $u2fconfig = get_u2f_config
();
418 my $u2f = PVE
::U2F-
>new();
420 # via the 'Host' header (in case a node has multiple hosts available).
421 my $origin = $u2fconfig->{origin
};
422 if (!defined($origin)) {
423 $origin = $rpcenv->get_request_host(1);
425 $origin = "https://$origin";
427 die "failed to figure out u2f origin\n";
431 my $appid = $u2fconfig->{appid
} // $origin;
432 $u2f->set_appid($appid);
433 $u2f->set_origin($origin);
434 $u2f->set_publicKey($publicKey) if defined($publicKey);
435 $u2f->set_keyHandle($keyHandle) if defined($keyHandle);
439 sub verify_user_tfa_config
{
440 my ($type, $tfa_cfg, $value) = @_;
442 if (!defined($type)) {
443 die "missing tfa 'type'\n";
446 if ($type ne 'oath') {
447 die "invalid type for custom tfa authentication\n";
450 my $secret = $tfa_cfg->{keys}
451 or die "missing TOTP secret\n";
452 $tfa_cfg = $tfa_cfg->{config
};
453 # Copy the hash to verify that we have no unexpected keys without modifying the original hash.
454 $tfa_cfg = {%$tfa_cfg};
456 # We can only verify 1 secret but oath_verify_otp allows multiple:
457 if (scalar(PVE
::Tools
::split_list
($secret)) != 1) {
458 die "only exactly one secret key allowed\n";
461 my $digits = delete($tfa_cfg->{digits
}) // 6;
462 my $step = delete($tfa_cfg->{step
}) // 30;
464 # my $algorithm = delete($tfa_cfg->{algorithm}) // 'sha1';
466 if (length(my $more = join(', ', keys %$tfa_cfg))) {
467 die "unexpected tfa config keys: $more\n";
470 PVE
::OTP
::oath_verify_otp
($value, $secret, $step, $digits);
474 __PACKAGE__-
>register_method({
475 name
=> 'permissions',
476 path
=> 'permissions',
478 description
=> 'Retrieve effective permissions of given user/token.',
480 description
=> "Each user/token is allowed to dump their own permissions. A user can dump the permissions of another user if they have 'Sys.Audit' permission on /access.",
484 additionalProperties
=> 0,
488 description
=> "User ID or full API token ID",
489 pattern
=> $PVE::AccessControl
::userid_or_token_regex
,
492 path
=> get_standard_option
('acl-path', {
493 description
=> "Only dump this specific path, not the whole tree.",
500 description
=> 'Map of "path" => (Map of "privilege" => "propagate boolean").',
505 my $rpcenv = PVE
::RPCEnvironment
::get
();
507 my $userid = $param->{userid
};
508 if (defined($userid)) {
509 $rpcenv->check($rpcenv->get_user(), '/access', ['Sys.Audit']);
511 $userid = $rpcenv->get_user();
516 if (my $path = $param->{path
}) {
517 my $perms = $rpcenv->permissions($userid, $path);
519 $res = { $path => $perms };
524 $res = $rpcenv->get_effective_permissions($userid);