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
::Auth
::Plugin
;
26 my $u2f_available = 0;
32 use base
qw(PVE::RESTHandler);
34 __PACKAGE__-
>register_method ({
35 subclass
=> "PVE::API2::User",
39 __PACKAGE__-
>register_method ({
40 subclass
=> "PVE::API2::Group",
44 __PACKAGE__-
>register_method ({
45 subclass
=> "PVE::API2::Role",
49 __PACKAGE__-
>register_method ({
50 subclass
=> "PVE::API2::ACL",
54 __PACKAGE__-
>register_method ({
55 subclass
=> "PVE::API2::Domains",
59 __PACKAGE__-
>register_method ({
63 description
=> "Directory index.",
68 additionalProperties
=> 0,
76 subdir
=> { type
=> 'string' },
79 links
=> [ { rel
=> 'child', href
=> "{subdir}" } ],
86 my $ma = __PACKAGE__-
>method_attributes();
88 foreach my $info (@$ma) {
89 next if !$info->{subclass
};
91 my $subpath = $info->{match_re
}->[0];
93 push @$res, { subdir
=> $subpath };
96 push @$res, { subdir
=> 'ticket' };
97 push @$res, { subdir
=> 'password' };
103 my $verify_auth = sub {
104 my ($rpcenv, $username, $pw_or_ticket, $otp, $path, $privs) = @_;
106 my $normpath = PVE
::AccessControl
::normalize_path
($path);
109 if (($ticketuser = PVE
::AccessControl
::verify_ticket
($pw_or_ticket, 1)) &&
110 ($ticketuser eq $username)) {
112 } elsif (PVE
::AccessControl
::verify_vnc_ticket
($pw_or_ticket, $username, $normpath, 1)) {
115 $username = PVE
::AccessControl
::authenticate_user
($username, $pw_or_ticket, $otp);
118 my $privlist = [ PVE
::Tools
::split_list
($privs) ];
119 if (!($normpath && scalar(@$privlist) && $rpcenv->check($username, $normpath, $privlist))) {
120 die "no permission ($path, $privs)\n";
123 return { username
=> $username };
126 my $create_ticket = sub {
127 my ($rpcenv, $username, $pw_or_ticket, $otp) = @_;
129 my ($ticketuser, undef, $tfa_info) = PVE
::AccessControl
::verify_ticket
($pw_or_ticket, 1);
130 if (defined($ticketuser) && ($ticketuser eq 'root@pam' || $ticketuser eq $username)) {
131 if (defined($tfa_info)) {
132 die "incomplete ticket\n";
134 # valid ticket. Note: root@pam can create tickets for other users
136 ($username, $tfa_info) = PVE
::AccessControl
::authenticate_user
($username, $pw_or_ticket, $otp);
140 my $ticket_data = $username;
141 if (defined($tfa_info)) {
143 if ($tfa_info->{type
} eq 'u2f') {
144 my $u2finfo = $tfa_info->{data
};
145 my $u2f = get_u2f_instance
($rpcenv, $u2finfo->@{qw(publicKey keyHandle)});
146 my $challenge = $u2f->auth_challenge()
147 or die "failed to get u2f challenge\n";
148 $challenge = decode_json
($challenge);
149 $extra{U2FChallenge
} = $challenge;
150 $ticket_data = "u2f!$username!$challenge->{challenge}";
152 # General half-login / 'missing 2nd factor' ticket:
153 $ticket_data = "tfa!$username";
157 my $ticket = PVE
::AccessControl
::assemble_ticket
($ticket_data);
158 my $csrftoken = PVE
::AccessControl
::assemble_csrf_prevention_token
($username);
162 username
=> $username,
163 CSRFPreventionToken
=> $csrftoken,
168 my $compute_api_permission = sub {
169 my ($rpcenv, $authuser) = @_;
171 my $usercfg = $rpcenv->{user_cfg
};
175 vms
=> qr/VM\.|Permissions\.Modify/,
176 access
=> qr/(User|Group)\.|Permissions\.Modify/,
177 storage
=> qr/Datastore\.|Permissions\.Modify/,
178 nodes
=> qr/Sys\.|Permissions\.Modify/,
179 dc
=> qr/Sys\.Audit/,
181 map { $res->{$_} = {} } keys %$priv_re_map;
183 my $required_paths = ['/', '/nodes', '/access/groups', '/vms', '/storage'];
185 my $checked_paths = {};
186 foreach my $path (@$required_paths, keys %{$usercfg->{acl
}}) {
187 next if $checked_paths->{$path};
188 $checked_paths->{$path} = 1;
190 my $path_perm = $rpcenv->permissions($authuser, $path);
192 my $toplevel = ($path =~ /^\/(\w
+)/) ?
$1 : 'dc';
193 if ($toplevel eq 'pool') {
194 foreach my $priv (keys %$path_perm) {
195 if ($priv =~ m/^VM\./) {
196 $res->{vms
}->{$priv} = 1;
197 } elsif ($priv =~ m/^Datastore\./) {
198 $res->{storage
}->{$priv} = 1;
199 } elsif ($priv eq 'Permissions.Modify') {
200 $res->{storage
}->{$priv} = 1;
201 $res->{vms
}->{$priv} = 1;
205 my $priv_regex = $priv_re_map->{$toplevel} // next;
206 foreach my $priv (keys %$path_perm) {
207 next if $priv !~ m/^($priv_regex)/;
208 $res->{$toplevel}->{$priv} = 1;
216 __PACKAGE__-
>register_method ({
217 name
=> 'get_ticket',
220 permissions
=> { user
=> 'world' },
221 description
=> "Dummy. Useful for formatters which want to provide a login page.",
223 additionalProperties
=> 0,
225 returns
=> { type
=> "null" },
226 code
=> sub { return undef; }});
228 __PACKAGE__-
>register_method ({
229 name
=> 'create_ticket',
233 description
=> "You need to pass valid credientials.",
236 protected
=> 1, # else we can't access shadow files
237 allowtoken
=> 0, # we don't want tokens to create tickets
238 description
=> "Create or verify authentication ticket.",
240 additionalProperties
=> 0,
243 description
=> "User name",
246 completion
=> \
&PVE
::AccessControl
::complete_username
,
248 realm
=> get_standard_option
('realm', {
249 description
=> "You can optionally pass the realm using this parameter. Normally the realm is simply added to the username <username>\@<relam>.",
251 completion
=> \
&PVE
::AccessControl
::complete_realm
,
254 description
=> "The secret password. This can also be a valid ticket.",
258 description
=> "One-time password for Two-factor authentication.",
263 description
=> "Verify ticket, and check if user have access 'privs' on 'path'",
270 description
=> "Verify ticket, and check if user have access 'privs' on 'path'",
271 type
=> 'string' , format
=> 'pve-priv-list',
281 username
=> { type
=> 'string' },
282 ticket
=> { type
=> 'string', optional
=> 1},
283 CSRFPreventionToken
=> { type
=> 'string', optional
=> 1 },
284 clustername
=> { type
=> 'string', optional
=> 1 },
285 # cap => computed api permissions, unless there's a u2f challenge
291 my $username = $param->{username
};
292 $username .= "\@$param->{realm}" if $param->{realm
};
294 my $rpcenv = PVE
::RPCEnvironment
::get
();
298 # test if user exists and is enabled
299 $rpcenv->check_user_enabled($username);
301 if ($param->{path
} && $param->{privs
}) {
302 $res = &$verify_auth($rpcenv, $username, $param->{password
}, $param->{otp
},
303 $param->{path
}, $param->{privs
});
305 $res = &$create_ticket($rpcenv, $username, $param->{password
}, $param->{otp
});
309 my $clientip = $rpcenv->get_client_ip() || '';
310 syslog
('err', "authentication failure; rhost=$clientip user=$username msg=$err");
311 # do not return any info to prevent user enumeration attacks
312 die PVE
::Exception-
>new("authentication failure\n", code
=> 401);
315 $res->{cap
} = &$compute_api_permission($rpcenv, $username)
316 if !defined($res->{NeedTFA
});
318 my $clinfo = PVE
::Cluster
::get_clinfo
();
319 if ($clinfo->{cluster
}->{name
} && $rpcenv->check($username, '/', ['Sys.Audit'], 1)) {
320 $res->{clustername
} = $clinfo->{cluster
}->{name
};
323 PVE
::Cluster
::log_msg
('info', 'root@pam', "successful auth for user '$username'");
328 __PACKAGE__-
>register_method ({
329 name
=> 'change_password',
333 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.",
335 ['userid-param', 'self'],
337 [ 'userid-param', 'Realm.AllocateUser'],
338 [ 'userid-group', ['User.Modify']]
342 protected
=> 1, # else we can't access shadow files
343 allowtoken
=> 0, # we don't want tokens to change the regular user password
344 description
=> "Change user password.",
346 additionalProperties
=> 0,
348 userid
=> get_standard_option
('userid-completed'),
350 description
=> "The new password.",
357 returns
=> { type
=> "null" },
361 my $rpcenv = PVE
::RPCEnvironment
::get
();
362 my $authuser = $rpcenv->get_user();
364 my ($userid, $ruid, $realm) = PVE
::AccessControl
::verify_username
($param->{userid
});
366 $rpcenv->check_user_exist($userid);
368 if ($authuser eq 'root@pam') {
369 # OK - root can change anything
371 if ($authuser eq $userid) {
372 $rpcenv->check_user_enabled($userid);
373 # OK - each user can change its own password
375 # only root may change root password
376 raise_perm_exc
() if $userid eq 'root@pam';
377 # do not allow to change system user passwords
378 raise_perm_exc
() if $realm eq 'pam';
382 PVE
::AccessControl
::domain_set_password
($realm, $ruid, $param->{password
});
384 PVE
::Cluster
::log_msg
('info', 'root@pam', "changed password for user '$userid'");
389 sub get_u2f_config
() {
390 die "u2f support not available\n" if !$u2f_available;
392 my $dc = cfs_read_file
('datacenter.cfg');
393 my $u2f = $dc->{u2f
};
394 die "u2f not configured in datacenter.cfg\n" if !$u2f;
398 sub get_u2f_instance
{
399 my ($rpcenv, $publicKey, $keyHandle) = @_;
401 # We store the public key base64 encoded (as the api provides it in binary)
402 $publicKey = decode_base64
($publicKey) if defined($publicKey);
404 my $u2fconfig = get_u2f_config
();
405 my $u2f = PVE
::U2F-
>new();
407 # via the 'Host' header (in case a node has multiple hosts available).
408 my $origin = $u2fconfig->{origin
};
409 if (!defined($origin)) {
410 $origin = $rpcenv->get_request_host(1);
412 $origin = "https://$origin";
414 die "failed to figure out u2f origin\n";
418 my $appid = $u2fconfig->{appid
} // $origin;
419 $u2f->set_appid($appid);
420 $u2f->set_origin($origin);
421 $u2f->set_publicKey($publicKey) if defined($publicKey);
422 $u2f->set_keyHandle($keyHandle) if defined($keyHandle);
426 sub verify_user_tfa_config
{
427 my ($type, $tfa_cfg, $value) = @_;
429 if (!defined($type)) {
430 die "missing tfa 'type'\n";
433 if ($type ne 'oath') {
434 die "invalid type for custom tfa authentication\n";
437 my $secret = $tfa_cfg->{keys}
438 or die "missing TOTP secret\n";
439 $tfa_cfg = $tfa_cfg->{config
};
440 # Copy the hash to verify that we have no unexpected keys without modifying the original hash.
441 $tfa_cfg = {%$tfa_cfg};
443 # We can only verify 1 secret but oath_verify_otp allows multiple:
444 if (scalar(PVE
::Tools
::split_list
($secret)) != 1) {
445 die "only exactly one secret key allowed\n";
448 my $digits = delete($tfa_cfg->{digits
}) // 6;
449 my $step = delete($tfa_cfg->{step
}) // 30;
451 # my $algorithm = delete($tfa_cfg->{algorithm}) // 'sha1';
453 if (length(my $more = join(', ', keys %$tfa_cfg))) {
454 die "unexpected tfa config keys: $more\n";
457 PVE
::OTP
::oath_verify_otp
($value, $secret, $step, $digits);
460 __PACKAGE__-
>register_method ({
461 name
=> 'change_tfa',
465 description
=> 'A user can change their own u2f or totp token.',
467 ['userid-param', 'self'],
469 [ 'userid-param', 'Realm.AllocateUser'],
470 [ 'userid-group', ['User.Modify']]
474 protected
=> 1, # else we can't access shadow files
475 allowtoken
=> 0, # we don't want tokens to change the regular user's TFA settings
476 description
=> "Change user u2f authentication.",
478 additionalProperties
=> 0,
480 userid
=> get_standard_option
('userid', {
481 completion
=> \
&PVE
::AccessControl
::complete_username
,
484 optional
=> 1, # Only required if not root@pam
485 description
=> "The current password.",
491 description
=> 'The action to perform',
493 enum
=> [qw(delete new confirm)],
498 'Either the the response to the current u2f registration challenge,'
499 .' or, when adding TOTP, the currently valid TOTP value.',
504 description
=> 'When adding TOTP, the shared secret value.',
506 format
=> 'pve-tfa-secret',
510 description
=> 'A TFA configuration. This must currently be of type TOTP of not set at all.',
512 format
=> 'pve-tfa-config',
517 returns
=> { type
=> 'object' },
521 my $rpcenv = PVE
::RPCEnvironment
::get
();
522 my $authuser = $rpcenv->get_user();
524 my $action = delete $param->{action
};
525 my $response = delete $param->{response
};
526 my $password = delete($param->{password
}) // '';
527 my $key = delete($param->{key
});
528 my $config = delete($param->{config
});
530 my ($userid, $ruid, $realm) = PVE
::AccessControl
::verify_username
($param->{userid
});
531 $rpcenv->check_user_exist($userid);
533 # Only root may modify root
534 raise_perm_exc
() if $userid eq 'root@pam' && $authuser ne 'root@pam';
536 # Regular users need to confirm their password to change u2f settings.
537 if ($authuser ne 'root@pam') {
538 raise_param_exc
({ 'password' => 'password is required to modify u2f data' })
539 if !defined($password);
540 my $domain_cfg = cfs_read_file
('domains.cfg');
541 my $cfg = $domain_cfg->{ids
}->{$realm};
542 die "auth domain '$realm' does not exist\n" if !$cfg;
543 my $plugin = PVE
::Auth
::Plugin-
>lookup($cfg->{type
});
544 $plugin->authenticate_user($cfg, $realm, $ruid, $password);
547 if ($action eq 'delete') {
548 PVE
::AccessControl
::user_set_tfa
($userid, $realm, undef, undef);
549 PVE
::Cluster
::log_msg
('info', $authuser, "deleted u2f data for user '$userid'");
550 } elsif ($action eq 'new') {
551 if (defined($config)) {
552 $config = PVE
::Auth
::Plugin
::parse_tfa_config
($config);
553 my $type = delete($config->{type
});
558 verify_user_tfa_config
($type, $tfa_cfg, $response);
559 PVE
::AccessControl
::user_set_tfa
($userid, $realm, $type, $tfa_cfg);
561 # The default is U2F:
562 my $u2f = get_u2f_instance
($rpcenv);
563 my $challenge = $u2f->registration_challenge()
564 or raise
("failed to get u2f challenge");
565 $challenge = decode_json
($challenge);
566 PVE
::AccessControl
::user_set_tfa
($userid, $realm, 'u2f', $challenge);
569 } elsif ($action eq 'confirm') {
570 raise_param_exc
({ 'response' => "confirm action requires the 'response' parameter to be set" })
571 if !defined($response);
573 my ($type, $u2fdata) = PVE
::AccessControl
::user_get_tfa
($userid, $realm);
574 raise
("no u2f data available")
575 if (!defined($type) || $type ne 'u2f');
577 my $challenge = $u2fdata->{challenge
}
578 or raise
("no active challenge");
580 my $u2f = get_u2f_instance
($rpcenv);
581 $u2f->set_challenge($challenge);
582 my ($keyHandle, $publicKey) = $u2f->registration_verify($response);
583 PVE
::AccessControl
::user_set_tfa
($userid, $realm, 'u2f', {
584 keyHandle
=> $keyHandle,
585 publicKey
=> $publicKey, # already base64 encoded
588 die "invalid action: $action\n";
594 __PACKAGE__-
>register_method({
595 name
=> 'verify_tfa',
598 permissions
=> { user
=> 'all' },
599 protected
=> 1, # else we can't access shadow files
600 allowtoken
=> 0, # we don't want tokens to access TFA information
601 description
=> 'Finish a u2f challenge.',
603 additionalProperties
=> 0,
607 description
=> 'The response to the current authentication challenge.',
614 ticket
=> { type
=> 'string' },
621 my $rpcenv = PVE
::RPCEnvironment
::get
();
622 my $authuser = $rpcenv->get_user();
623 my ($username, undef, $realm) = PVE
::AccessControl
::verify_username
($authuser);
625 my ($tfa_type, $tfa_data) = PVE
::AccessControl
::user_get_tfa
($username, $realm);
626 if (!defined($tfa_type)) {
627 raise
('no u2f data available');
631 if ($tfa_type eq 'u2f') {
632 my $challenge = $rpcenv->get_u2f_challenge()
633 or raise
('no active challenge');
635 my $keyHandle = $tfa_data->{keyHandle
};
636 my $publicKey = $tfa_data->{publicKey
};
637 raise
("incomplete u2f setup")
638 if !defined($keyHandle) || !defined($publicKey);
640 my $u2f = get_u2f_instance
($rpcenv, $publicKey, $keyHandle);
641 $u2f->set_challenge($challenge);
643 my ($counter, $present) = $u2f->auth_verify($param->{response
});
644 # Do we want to do anything with these?
646 # sanity check before handing off to the verification code:
647 my $keys = $tfa_data->{keys} or die "missing tfa keys\n";
648 my $config = $tfa_data->{config
} or die "bad tfa entry\n";
649 PVE
::AccessControl
::verify_one_time_pw
($tfa_type, $authuser, $keys, $config, $param->{response
});
653 my $clientip = $rpcenv->get_client_ip() || '';
654 syslog
('err', "authentication verification failure; rhost=$clientip user=$authuser msg=$err");
655 die PVE
::Exception-
>new("authentication failure\n", code
=> 401);
659 ticket
=> PVE
::AccessControl
::assemble_ticket
($authuser),
660 cap
=> &$compute_api_permission($rpcenv, $authuser),
664 __PACKAGE__-
>register_method({
665 name
=> 'permissions',
666 path
=> 'permissions',
668 description
=> 'Retrieve effective permissions of given user/token.',
670 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.",
674 additionalProperties
=> 0,
678 description
=> "User ID or full API token ID",
679 pattern
=> $PVE::AccessControl
::userid_or_token_regex
,
682 path
=> get_standard_option
('acl-path', {
683 description
=> "Only dump this specific path, not the whole tree.",
690 description
=> 'Map of "path" => (Map of "privilege" => "propagate boolean").',
695 my $rpcenv = PVE
::RPCEnvironment
::get
();
697 my $userid = $param->{userid
};
698 if (defined($userid)) {
699 $rpcenv->check($rpcenv->get_user(), '/access', ['Sys.Audit']);
701 $userid = $rpcenv->get_user();
706 if (my $path = $param->{path
}) {
707 my $perms = $rpcenv->permissions($userid, $path);
709 $res = { $path => $perms };
714 $res = $rpcenv->get_effective_permissions($userid);