1 package PVE
::API2
::AccessControl
;
9 use PVE
::Exception
qw(raise raise_perm_exc);
11 use PVE
::RPCEnvironment
;
12 use PVE
::Cluster
qw(cfs_read_file);
15 use PVE
::AccessControl
;
16 use PVE
::JSONSchema
qw(get_standard_option);
17 use PVE
::API2
::Domains
;
25 my $u2f_available = 0;
31 use base
qw(PVE::RESTHandler);
33 __PACKAGE__-
>register_method ({
34 subclass
=> "PVE::API2::User",
38 __PACKAGE__-
>register_method ({
39 subclass
=> "PVE::API2::Group",
43 __PACKAGE__-
>register_method ({
44 subclass
=> "PVE::API2::Role",
48 __PACKAGE__-
>register_method ({
49 subclass
=> "PVE::API2::ACL",
53 __PACKAGE__-
>register_method ({
54 subclass
=> "PVE::API2::Domains",
58 __PACKAGE__-
>register_method ({
62 description
=> "Directory index.",
67 additionalProperties
=> 0,
75 subdir
=> { type
=> 'string' },
78 links
=> [ { rel
=> 'child', href
=> "{subdir}" } ],
85 my $ma = __PACKAGE__-
>method_attributes();
87 foreach my $info (@$ma) {
88 next if !$info->{subclass
};
90 my $subpath = $info->{match_re
}->[0];
92 push @$res, { subdir
=> $subpath };
95 push @$res, { subdir
=> 'ticket' };
96 push @$res, { subdir
=> 'password' };
102 my $verify_auth = sub {
103 my ($rpcenv, $username, $pw_or_ticket, $otp, $path, $privs) = @_;
105 my $normpath = PVE
::AccessControl
::normalize_path
($path);
108 if (($ticketuser = PVE
::AccessControl
::verify_ticket
($pw_or_ticket, 1)) &&
109 ($ticketuser eq $username)) {
111 } elsif (PVE
::AccessControl
::verify_vnc_ticket
($pw_or_ticket, $username, $normpath, 1)) {
114 $username = PVE
::AccessControl
::authenticate_user
($username, $pw_or_ticket, $otp);
117 my $privlist = [ PVE
::Tools
::split_list
($privs) ];
118 if (!($normpath && scalar(@$privlist) && $rpcenv->check($username, $normpath, $privlist))) {
119 die "no permission ($path, $privs)\n";
122 return { username
=> $username };
125 my $create_ticket = sub {
126 my ($rpcenv, $username, $pw_or_ticket, $otp) = @_;
128 my ($ticketuser, undef, $tfa_info) = PVE
::AccessControl
::verify_ticket
($pw_or_ticket, 1);
129 if (defined($ticketuser) && ($ticketuser eq 'root@pam' || $ticketuser eq $username)) {
130 if (defined($tfa_info)) {
131 die "incomplete ticket\n";
133 # valid ticket. Note: root@pam can create tickets for other users
135 ($username, $tfa_info) = PVE
::AccessControl
::authenticate_user
($username, $pw_or_ticket, $otp);
139 my $ticket_data = $username;
140 if (defined($tfa_info)) {
142 if ($tfa_info->{type
} eq 'u2f') {
143 my $u2finfo = $tfa_info->{data
};
144 my $u2f = get_u2f_instance
($rpcenv, $u2finfo->@{qw(publicKey keyHandle)});
145 my $challenge = $u2f->auth_challenge()
146 or die "failed to get u2f challenge\n";
147 $challenge = decode_json
($challenge);
148 $extra{U2FChallenge
} = $challenge;
149 $ticket_data = "u2f!$username!$challenge->{challenge}";
151 # General half-login / 'missing 2nd factor' ticket:
152 $ticket_data = "tfa!$username";
156 my $ticket = PVE
::AccessControl
::assemble_ticket
($ticket_data);
157 my $csrftoken = PVE
::AccessControl
::assemble_csrf_prevention_token
($username);
161 username
=> $username,
162 CSRFPreventionToken
=> $csrftoken,
167 my $compute_api_permission = sub {
168 my ($rpcenv, $authuser) = @_;
170 my $usercfg = $rpcenv->{user_cfg
};
174 vms
=> qr/VM\.|Permissions\.Modify/,
175 access
=> qr/(User|Group)\.|Permissions\.Modify/,
176 storage
=> qr/Datastore\.|Permissions\.Modify/,
177 nodes
=> qr/Sys\.|Permissions\.Modify/,
178 dc
=> qr/Sys\.Audit/,
180 map { $res->{$_} = {} } keys %$priv_re_map;
182 my $required_paths = ['/', '/nodes', '/access/groups', '/vms', '/storage'];
184 my $checked_paths = {};
185 foreach my $path (@$required_paths, keys %{$usercfg->{acl
}}) {
186 next if $checked_paths->{$path};
187 $checked_paths->{$path} = 1;
189 my $path_perm = $rpcenv->permissions($authuser, $path);
191 my $toplevel = ($path =~ /^\/(\w
+)/) ?
$1 : 'dc';
192 if ($toplevel eq 'pool') {
193 foreach my $priv (keys %$path_perm) {
194 if ($priv =~ m/^VM\./) {
195 $res->{vms
}->{$priv} = 1;
196 } elsif ($priv =~ m/^Datastore\./) {
197 $res->{storage
}->{$priv} = 1;
198 } elsif ($priv eq 'Permissions.Modify') {
199 $res->{storage
}->{$priv} = 1;
200 $res->{vms
}->{$priv} = 1;
204 my $priv_regex = $priv_re_map->{$toplevel} // next;
205 foreach my $priv (keys %$path_perm) {
206 next if $priv !~ m/^($priv_regex)/;
207 $res->{$toplevel}->{$priv} = 1;
215 __PACKAGE__-
>register_method ({
216 name
=> 'get_ticket',
219 permissions
=> { user
=> 'world' },
220 description
=> "Dummy. Useful for formatters which want to provide a login page.",
222 additionalProperties
=> 0,
224 returns
=> { type
=> "null" },
225 code
=> sub { return undef; }});
227 __PACKAGE__-
>register_method ({
228 name
=> 'create_ticket',
232 description
=> "You need to pass valid credientials.",
235 protected
=> 1, # else we can't access shadow files
236 description
=> "Create or verify authentication ticket.",
238 additionalProperties
=> 0,
241 description
=> "User name",
244 completion
=> \
&PVE
::AccessControl
::complete_username
,
246 realm
=> get_standard_option
('realm', {
247 description
=> "You can optionally pass the realm using this parameter. Normally the realm is simply added to the username <username>\@<relam>.",
249 completion
=> \
&PVE
::AccessControl
::complete_realm
,
252 description
=> "The secret password. This can also be a valid ticket.",
256 description
=> "One-time password for Two-factor authentication.",
261 description
=> "Verify ticket, and check if user have access 'privs' on 'path'",
268 description
=> "Verify ticket, and check if user have access 'privs' on 'path'",
269 type
=> 'string' , format
=> 'pve-priv-list',
279 username
=> { type
=> 'string' },
280 ticket
=> { type
=> 'string', optional
=> 1},
281 CSRFPreventionToken
=> { type
=> 'string', optional
=> 1 },
282 clustername
=> { type
=> 'string', optional
=> 1 },
283 # cap => computed api permissions, unless there's a u2f challenge
289 my $username = $param->{username
};
290 $username .= "\@$param->{realm}" if $param->{realm
};
292 my $rpcenv = PVE
::RPCEnvironment
::get
();
296 # test if user exists and is enabled
297 $rpcenv->check_user_enabled($username);
299 if ($param->{path
} && $param->{privs
}) {
300 $res = &$verify_auth($rpcenv, $username, $param->{password
}, $param->{otp
},
301 $param->{path
}, $param->{privs
});
303 $res = &$create_ticket($rpcenv, $username, $param->{password
}, $param->{otp
});
307 my $clientip = $rpcenv->get_client_ip() || '';
308 syslog
('err', "authentication failure; rhost=$clientip user=$username msg=$err");
309 # do not return any info to prevent user enumeration attacks
310 die PVE
::Exception-
>new("authentication failure\n", code
=> 401);
313 $res->{cap
} = &$compute_api_permission($rpcenv, $username)
314 if !defined($res->{NeedTFA
});
316 if (PVE
::Corosync
::check_conf_exists
(1)) {
317 if ($rpcenv->check($username, '/', ['Sys.Audit'], 1)) {
319 my $conf = cfs_read_file
('corosync.conf');
320 my $totem = PVE
::Corosync
::totem_config
($conf);
321 if ($totem->{cluster_name
}) {
322 $res->{clustername
} = $totem->{cluster_name
};
329 PVE
::Cluster
::log_msg
('info', 'root@pam', "successful auth for user '$username'");
334 __PACKAGE__-
>register_method ({
335 name
=> 'change_password',
339 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.",
341 ['userid-param', 'self'],
343 [ 'userid-param', 'Realm.AllocateUser'],
344 [ 'userid-group', ['User.Modify']]
348 protected
=> 1, # else we can't access shadow files
349 description
=> "Change user password.",
351 additionalProperties
=> 0,
353 userid
=> get_standard_option
('userid-completed'),
355 description
=> "The new password.",
362 returns
=> { type
=> "null" },
366 my $rpcenv = PVE
::RPCEnvironment
::get
();
367 my $authuser = $rpcenv->get_user();
369 my ($userid, $ruid, $realm) = PVE
::AccessControl
::verify_username
($param->{userid
});
371 $rpcenv->check_user_exist($userid);
373 if ($authuser eq 'root@pam') {
374 # OK - root can change anything
376 if ($authuser eq $userid) {
377 $rpcenv->check_user_enabled($userid);
378 # OK - each user can change its own password
380 # only root may change root password
381 raise_perm_exc
() if $userid eq 'root@pam';
382 # do not allow to change system user passwords
383 raise_perm_exc
() if $realm eq 'pam';
387 PVE
::AccessControl
::domain_set_password
($realm, $ruid, $param->{password
});
389 PVE
::Cluster
::log_msg
('info', 'root@pam', "changed password for user '$userid'");
394 sub get_u2f_config
() {
395 die "u2f support not available\n" if !$u2f_available;
397 my $dc = cfs_read_file
('datacenter.cfg');
398 my $u2f = $dc->{u2f
};
399 die "u2f not configured in datacenter.cfg\n" if !$u2f;
400 $u2f = PVE
::JSONSchema
::parse_property_string
($PVE::Cluster
::u2f_format
, $u2f);
404 sub get_u2f_instance
{
405 my ($rpcenv, $publicKey, $keyHandle) = @_;
407 # We store the public key base64 encoded (as the api provides it in binary)
408 $publicKey = decode_base64
($publicKey) if defined($publicKey);
410 my $u2fconfig = get_u2f_config
();
411 my $u2f = PVE
::U2F-
>new();
413 # via the 'Host' header (in case a node has multiple hosts available).
414 my $origin = $u2fconfig->{origin
};
415 if (!defined($origin)) {
416 $origin = $rpcenv->get_request_host(1);
418 $origin = "https://$origin";
420 die "failed to figure out u2f origin\n";
424 my $appid = $u2fconfig->{appid
} // $origin;
425 $u2f->set_appid($appid);
426 $u2f->set_origin($origin);
427 $u2f->set_publicKey($publicKey) if defined($publicKey);
428 $u2f->set_keyHandle($keyHandle) if defined($keyHandle);
432 sub verify_user_tfa_config
{
433 my ($type, $tfa_cfg, $value) = @_;
435 if (!defined($type)) {
436 die "missing tfa 'type'\n";
439 if ($type ne 'oath') {
440 die "invalid type for custom tfa authentication\n";
443 my $secret = $tfa_cfg->{keys}
444 or die "missing TOTP secret\n";
445 $tfa_cfg = $tfa_cfg->{config
};
446 # Copy the hash to verify that we have no unexpected keys without modifying the original hash.
447 $tfa_cfg = {%$tfa_cfg};
449 # We can only verify 1 secret but oath_verify_otp allows multiple:
450 if (scalar(PVE
::Tools
::split_list
($secret)) != 1) {
451 die "only exactly one secret key allowed\n";
454 my $digits = delete($tfa_cfg->{digits
}) // 6;
455 my $step = delete($tfa_cfg->{step
}) // 30;
457 # my $algorithm = delete($tfa_cfg->{algorithm}) // 'sha1';
459 if (length(my $more = join(', ', keys %$tfa_cfg))) {
460 die "unexpected tfa config keys: $more\n";
463 PVE
::OTP
::oath_verify_otp
($value, $secret, $step, $digits);
466 __PACKAGE__-
>register_method ({
467 name
=> 'change_tfa',
471 description
=> 'A user can change their own u2f or totp token.',
473 ['userid-param', 'self'],
475 [ 'userid-param', 'Realm.AllocateUser'],
476 [ 'userid-group', ['User.Modify']]
480 protected
=> 1, # else we can't access shadow files
481 description
=> "Change user u2f authentication.",
483 additionalProperties
=> 0,
485 userid
=> get_standard_option
('userid', {
486 completion
=> \
&PVE
::AccessControl
::complete_username
,
489 optional
=> 1, # Only required if not root@pam
490 description
=> "The current password.",
496 description
=> 'The action to perform',
498 enum
=> [qw(delete new confirm)],
503 'Either the the response to the current u2f registration challenge,'
504 .' or, when adding TOTP, the currently valid TOTP value.',
509 description
=> 'When adding TOTP, the shared secret value.',
511 # This is what pve-common's PVE::OTP::oath_verify_otp accepts.
512 # Should we move this to pve-common's JSONSchema as a named format?
513 pattern
=> qr/[A-Z2-7=]{16}|[A-Fa-f0-9]{40}/,
517 description
=> 'A TFA configuration. This must currently be of type TOTP of not set at all.',
519 format
=> 'pve-tfa-config',
524 returns
=> { type
=> 'object' },
528 my $rpcenv = PVE
::RPCEnvironment
::get
();
529 my $authuser = $rpcenv->get_user();
531 my $action = delete $param->{action
};
532 my $response = delete $param->{response
};
533 my $password = delete($param->{password
}) // '';
534 my $key = delete($param->{key
});
535 my $config = delete($param->{config
});
537 my ($userid, $ruid, $realm) = PVE
::AccessControl
::verify_username
($param->{userid
});
538 $rpcenv->check_user_exist($userid);
540 # Only root may modify root
541 raise_perm_exc
() if $userid eq 'root@pam' && $authuser ne 'root@pam';
543 # Regular users need to confirm their password to change u2f settings.
544 if ($authuser ne 'root@pam') {
545 raise_param_exc
('password' => 'password is required to modify u2f data')
546 if !defined($password);
547 my $domain_cfg = cfs_read_file
('domains.cfg');
548 my $cfg = $domain_cfg->{ids
}->{$realm};
549 die "auth domain '$realm' does not exists\n" if !$cfg;
550 my $plugin = PVE
::Auth
::Plugin-
>lookup($cfg->{type
});
551 $plugin->authenticate_user($cfg, $realm, $ruid, $password);
554 if ($action eq 'delete') {
555 PVE
::AccessControl
::user_set_tfa
($userid, $realm, undef, undef);
556 PVE
::Cluster
::log_msg
('info', $authuser, "deleted u2f data for user '$userid'");
557 } elsif ($action eq 'new') {
558 if (defined($config)) {
559 $config = PVE
::Auth
::Plugin
::parse_tfa_config
($config);
560 my $type = delete($config->{type
});
565 verify_user_tfa_config
($type, $tfa_cfg, $response);
566 PVE
::AccessControl
::user_set_tfa
($userid, $realm, $type, $tfa_cfg);
568 # The default is U2F:
569 my $u2f = get_u2f_instance
($rpcenv);
570 my $challenge = $u2f->registration_challenge()
571 or raise
("failed to get u2f challenge");
572 $challenge = decode_json
($challenge);
573 PVE
::AccessControl
::user_set_tfa
($userid, $realm, 'u2f', $challenge);
576 } elsif ($action eq 'confirm') {
577 raise_param_exc
('response' => "confirm action requires the 'response' parameter to be set")
578 if !defined($response);
580 my ($type, $u2fdata) = PVE
::AccessControl
::user_get_tfa
($userid, $realm);
581 raise
("no u2f data available")
582 if (!defined($type) || $type ne 'u2f');
584 my $challenge = $u2fdata->{challenge
}
585 or raise
("no active challenge");
587 my $u2f = get_u2f_instance
($rpcenv);
588 $u2f->set_challenge($challenge);
589 my ($keyHandle, $publicKey) = $u2f->registration_verify($response);
590 PVE
::AccessControl
::user_set_tfa
($userid, $realm, 'u2f', {
591 keyHandle
=> $keyHandle,
592 publicKey
=> encode_base64
($publicKey, ''),
595 die "invalid action: $action\n";
601 __PACKAGE__-
>register_method({
602 name
=> 'verify_tfa',
605 permissions
=> { user
=> 'all' },
606 protected
=> 1, # else we can't access shadow files
607 description
=> 'Finish a u2f challenge.',
609 additionalProperties
=> 0,
613 description
=> 'The response to the current authentication challenge.',
620 ticket
=> { type
=> 'string' },
627 my $rpcenv = PVE
::RPCEnvironment
::get
();
628 my $authuser = $rpcenv->get_user();
629 my ($username, undef, $realm) = PVE
::AccessControl
::verify_username
($authuser);
631 my ($tfa_type, $tfa_data) = PVE
::AccessControl
::user_get_tfa
($username, $realm);
632 if (!defined($tfa_type)) {
633 raise
('no u2f data available');
637 if ($tfa_type eq 'u2f') {
638 my $challenge = $rpcenv->get_u2f_challenge()
639 or raise
('no active challenge');
641 my $keyHandle = $tfa_data->{keyHandle
};
642 my $publicKey = $tfa_data->{publicKey
};
643 raise
("incomplete u2f setup")
644 if !defined($keyHandle) || !defined($publicKey);
646 my $u2f = get_u2f_instance
($rpcenv, $publicKey, $keyHandle);
647 $u2f->set_challenge($challenge);
649 my ($counter, $present) = $u2f->auth_verify($param->{response
});
650 # Do we want to do anything with these?
652 # sanity check before handing off to the verification code:
653 my $keys = $tfa_data->{keys} or die "missing tfa keys\n";
654 my $config = $tfa_data->{config
} or die "bad tfa entry\n";
655 PVE
::AccessControl
::verify_one_time_pw
($tfa_type, $authuser, $keys, $config, $param->{response
});
659 my $clientip = $rpcenv->get_client_ip() || '';
660 syslog
('err', "authentication verification failure; rhost=$clientip user=$authuser msg=$err");
661 die PVE
::Exception-
>new("authentication failure\n", code
=> 401);
665 ticket
=> PVE
::AccessControl
::assemble_ticket
($authuser),
666 cap
=> &$compute_api_permission($rpcenv, $authuser),