1 package PVE
::AccessControl
;
6 use Crypt
::OpenSSL
::Random
;
7 use Crypt
::OpenSSL
::RSA
;
16 use Scalar
::Util
'weaken';
21 use PVE
::Tools
qw(run_command lock_file file_get_contents split_list safe_print);
22 use PVE
::Cluster
qw(cfs_register_file cfs_read_file cfs_write_file cfs_lock_file);
23 use PVE
::JSONSchema
qw(register_standard_option get_standard_option);
27 use PVE
::Auth
::Plugin
;
32 use PVE
::Auth
::OpenId
;
34 # load and initialize all plugins
36 PVE
::Auth
::AD-
>register();
37 PVE
::Auth
::LDAP-
>register();
38 PVE
::Auth
::PVE-
>register();
39 PVE
::Auth
::PAM-
>register();
40 PVE
::Auth
::OpenId-
>register();
41 PVE
::Auth
::Plugin-
>init();
43 # $authdir must be writable by root only!
44 my $confdir = "/etc/pve";
45 my $authdir = "$confdir/priv";
47 my $pve_www_key_fn = "$confdir/pve-www.key";
49 my $pve_auth_key_files = {
50 priv
=> "$authdir/authkey.key",
51 pub
=> "$confdir/authkey.pub",
52 pubold
=> "$confdir/authkey.pub.old",
55 my $pve_auth_key_cache = {};
57 my $ticket_lifetime = 3600 * 2; # 2 hours
58 my $auth_graceperiod = 60 * 5; # 5 minutes
59 my $authkey_lifetime = 3600 * 24; # rotate every 24 hours
61 Crypt
::OpenSSL
::RSA-
>import_random_seed();
63 cfs_register_file
('user.cfg', \
&parse_user_config
, \
&write_user_config
);
64 cfs_register_file
('priv/tfa.cfg', \
&parse_priv_tfa_config
, \
&write_priv_tfa_config
);
67 PVE
::Auth
::Plugin
::verify_username
(@_);
70 sub pve_verify_realm
{
71 PVE
::Auth
::Plugin
::pve_verify_realm
(@_);
74 # Locking both config files together is only ever allowed in one order:
77 # If we permit the other way round, too, we might end up deadlocking!
78 my $user_config_locked;
79 sub lock_user_config
{
80 my ($code, $errmsg) = @_;
83 $user_config_locked = \
$locked;
84 weaken
$user_config_locked; # make this scope guard signal safe...
86 cfs_lock_file
("user.cfg", undef, $code);
87 $user_config_locked = undef;
89 $errmsg ?
die "$errmsg: $err" : die $err;
94 my ($code, $errmsg) = @_;
96 die "tfa config lock cannot be acquired while holding user config lock\n"
97 if ($user_config_locked && $$user_config_locked);
99 my $res = cfs_lock_file
("priv/tfa.cfg", undef, $code);
101 $errmsg ?
die "$errmsg: $err" : die $err;
107 my $cache_read_key = sub {
110 my $path = $pve_auth_key_files->{$type};
112 my $read_key_and_mtime = sub {
113 my $fh = IO
::File-
>new($path, "r");
115 return undef if !defined($fh);
118 my $pem = PVE
::Tools
::safe_read_from
($fh, 0, 0, $path);
123 if ($type eq 'pub' || $type eq 'pubold') {
124 $key = eval { Crypt
::OpenSSL
::RSA-
>new_public_key($pem); };
125 } elsif ($type eq 'priv') {
126 $key = eval { Crypt
::OpenSSL
::RSA-
>new_private_key($pem); };
128 die "Invalid authkey type '$type'\n";
131 return { key
=> $key, mtime
=> $st->mtime };
134 if (!defined($pve_auth_key_cache->{$type})) {
135 $pve_auth_key_cache->{$type} = $read_key_and_mtime->();
137 my $st = stat($path);
138 if (!$st || $st->mtime != $pve_auth_key_cache->{$type}->{mtime
}) {
139 $pve_auth_key_cache->{$type} = $read_key_and_mtime->();
143 return $pve_auth_key_cache->{$type};
149 my $type = $old ?
'pubold' : 'pub';
151 my $res = $cache_read_key->($type);
152 return undef if !defined($res);
154 return wantarray ?
($res->{key
}, $res->{mtime
}) : $res->{key
};
158 my $res = $cache_read_key->('priv');
160 if (!defined($res) || !check_authkey
(1)) {
162 $res = $cache_read_key->('priv');
165 return wantarray ?
($res->{key
}, $res->{mtime
}) : $res->{key
};
171 # skip check if non-quorate, as rotation is not possible anyway
172 return 1 if !PVE
::Cluster
::check_cfs_quorum
(1);
174 my ($pub_key, $mtime) = get_pubkey
();
176 warn "auth key pair missing, generating new one..\n" if !$quiet;
180 if ($now - $mtime >= $authkey_lifetime) {
181 warn "auth key pair too old, rotating..\n" if !$quiet;;
183 } elsif ($mtime > $now + $auth_graceperiod) {
184 # a nodes RTC had a time set in the future during key generation -> ticket
185 # validity is clamped to 0+5 min grace period until now >= mtime again
186 my (undef, $old_mtime) = get_pubkey
(1);
187 if ($old_mtime && $mtime >= $old_mtime && $mtime - $old_mtime < $ticket_lifetime) {
188 warn "auth key pair generated in the future (key $mtime > host $now),"
189 ." but old key still exists and in valid grace period so avoid automatic"
190 ." fixup. Cluster time not in sync?\n" if !$quiet;
193 warn "auth key pair generated in the future (key $mtime > host $now), rotating..\n" if !$quiet;
196 warn "auth key new enough, skipping rotation\n" if !$quiet;;
203 return if $authkey_lifetime == 0;
205 PVE
::Cluster
::cfs_lock_authkey
(undef, sub {
206 # stat() calls might be answered from the kernel page cache for up to
207 # 1s, so this special dance is needed to avoid a double rotation in
208 # clusters *despite* the cfs_lock context..
210 # drop in-process cache hash
211 $pve_auth_key_cache = {};
212 # force open/close of file to invalidate page cache entry
214 # now re-check with lock held and page cache invalidated so that stat()
215 # does the right thing, and any key updates by other nodes are visible.
216 return if check_authkey
();
218 my $old = get_pubkey
();
219 my $new = Crypt
::OpenSSL
::RSA-
>generate_key(2048);
223 my $pem = $old->get_public_key_x509_string();
224 # mtime is used for caching and ticket age range calculation
225 PVE
::Tools
::file_set_contents
($pve_auth_key_files->{pubold
}, $pem);
227 die "Failed to store old auth key: $@\n" if $@;
231 my $pem = $new->get_public_key_x509_string();
232 # mtime is used for caching and ticket age range calculation,
233 # should be close to that of pubold above
234 PVE
::Tools
::file_set_contents
($pve_auth_key_files->{pub
}, $pem);
238 warn "Failed to store new auth key - $@\n";
239 warn "Reverting to previous auth key\n";
241 my $pem = $old->get_public_key_x509_string();
242 PVE
::Tools
::file_set_contents
($pve_auth_key_files->{pub
}, $pem);
244 die "Failed to restore old auth key: $@\n" if $@;
246 die "Failed to store new auth key - $@\n";
251 my $pem = $new->get_private_key_string();
252 PVE
::Tools
::file_set_contents
($pve_auth_key_files->{priv
}, $pem);
255 warn "Failed to store new auth key - $@\n";
256 warn "Deleting auth key to force regeneration\n";
257 unlink $pve_auth_key_files->{pub
};
258 unlink $pve_auth_key_files->{priv
};
264 PVE
::JSONSchema
::register_standard_option
('tokenid', {
265 description
=> "API token identifier.",
267 format
=> "pve-tokenid",
270 our $token_subid_regex = $PVE::Auth
::Plugin
::realm_regex
;
272 # username@realm username realm tokenid
273 our $token_full_regex = qr/((${PVE::Auth::Plugin::user_regex})\@(${PVE::Auth::Plugin::realm_regex}))!(${token_subid_regex})/;
275 our $userid_or_token_regex = qr/^$PVE::Auth::Plugin::user_regex\@$PVE::Auth::Plugin::realm_regex(?:!$token_subid_regex)?$/;
278 my ($tokenid, $noerr) = @_;
280 if ($tokenid =~ /^${token_full_regex}$/) {
284 die "'$tokenid' is not a valid token ID - not able to split into user and token parts\n" if !$noerr;
290 my ($username, $tokensubid) = @_;
292 my $joined = "${username}!${tokensubid}";
294 return pve_verify_tokenid
($joined);
297 PVE
::JSONSchema
::register_format
('pve-tokenid', \
&pve_verify_tokenid
);
298 sub pve_verify_tokenid
{
299 my ($tokenid, $noerr) = @_;
301 if ($tokenid =~ /^${token_full_regex}$/) {
302 return wantarray ?
($tokenid, $2, $3, $4) : $tokenid;
305 die "value '$tokenid' does not look like a valid token ID\n" if !$noerr;
311 my $csrf_prevention_secret;
312 my $csrf_prevention_secret_legacy;
313 my $get_csrfr_secret = sub {
314 if (!$csrf_prevention_secret) {
315 my $input = PVE
::Tools
::file_get_contents
($pve_www_key_fn);
316 $csrf_prevention_secret = Digest
::SHA
::hmac_sha256_base64
($input);
317 $csrf_prevention_secret_legacy = Digest
::SHA
::sha1_base64
($input);
319 return $csrf_prevention_secret;
322 sub assemble_csrf_prevention_token
{
325 my $secret = &$get_csrfr_secret();
327 return PVE
::Ticket
::assemble_csrf_prevention_token
($secret, $username);
330 sub verify_csrf_prevention_token
{
331 my ($username, $token, $noerr) = @_;
333 my $secret = $get_csrfr_secret->();
335 # FIXME: remove with PVE 7 and/or refactor all into PVE::Ticket ?
336 if ($token =~ m/^([A-Z0-9]{8}):(\S+)$/) {
338 if (length($sig) == 27) {
339 # the legacy secret got populated by above get_csrfr_secret call
340 $secret = $csrf_prevention_secret_legacy;
344 return PVE
::Ticket
::verify_csrf_prevention_token
(
345 $secret, $username, $token, -$auth_graceperiod, $ticket_lifetime, $noerr);
348 my $get_ticket_age_range = sub {
349 my ($now, $mtime, $rotated) = @_;
351 my $key_age = $now - $mtime;
352 $key_age = 0 if $key_age < 0;
354 my $min = -$auth_graceperiod;
355 my $max = $ticket_lifetime;
358 # ticket creation after rotation is not allowed
359 $min = $key_age - $auth_graceperiod;
361 if ($key_age > $authkey_lifetime && $authkey_lifetime > 0) {
362 if (PVE
::Cluster
::check_cfs_quorum
(1)) {
363 # key should have been rotated, clamp range accordingly
364 $min = $key_age - $authkey_lifetime;
366 warn "Cluster not quorate - extending auth key lifetime!\n";
370 $max = $key_age + $auth_graceperiod if $key_age < $ticket_lifetime;
373 return undef if $min > $ticket_lifetime;
377 sub assemble_ticket
: prototype($;$) {
378 my ($data, $aad) = @_;
380 my $rsa_priv = get_privkey
();
382 return PVE
::Ticket
::assemble_rsa_ticket
($rsa_priv, 'PVE', $data, $aad);
385 # Returns the username, "age" and tfa info.
387 # Note that for the new-style outh, tfa info is never set, as it only uses the `/ticket` api call
388 # via the new 'tfa-challenge' parameter, so this part can go with PVE-8.
390 # New-style auth still uses this function, but sets `$tfa_ticket` to true when validating the tfa
392 sub verify_ticket
: prototype($;$$) {
393 my ($ticket, $noerr, $tfa_ticket_aad) = @_;
400 my ($rsa_pub, $rsa_mtime) = get_pubkey
($old);
401 return undef if !$rsa_pub;
403 my ($min, $max) = $get_ticket_age_range->($now, $rsa_mtime, $old);
404 return undef if !defined($min);
406 return PVE
::Ticket
::verify_rsa_ticket
(
407 $rsa_pub, 'PVE', $ticket, $tfa_ticket_aad, $min, $max, 1);
410 my ($data, $age) = $check->();
412 # check with old, rotated key if current key failed
413 ($data, $age) = $check->(1) if !defined($data);
415 my $auth_failure = sub {
419 # raise error via undef ticket
420 PVE
::Ticket
::verify_rsa_ticket
(undef, 'PVE');
424 if (!defined($data)) {
425 return $auth_failure->();
428 if ($tfa_ticket_aad) {
429 # We're validating a ticket-call's 'tfa-challenge' parameter, so just return its data.
430 if ($data =~ /^!tfa!(.*)$/) {
436 my ($username, $tfa_info);
437 if ($data =~ /^!tfa!(.*)$/) {
438 # PBS style half-authenticated ticket, contains a json string form of a `TfaChallenge`
440 # This type of ticket does not contain the user name.
441 return { type
=> 'new', data
=> $1 };
443 if ($data =~ m{^u2f!([^!]+)!([0-9a-zA-Z/.=_\-+]+)$}) {
444 # Ticket for u2f-users:
445 ($username, my $challenge) = ($1, $2);
446 if ($challenge eq 'verified') {
447 # u2f challenge was completed
449 } elsif (!wantarray) {
450 # The caller is not aware there could be an ongoing challenge,
451 # so we treat this ticket as invalid:
452 return $auth_failure->();
456 challenge
=> $challenge,
458 } elsif ($data =~ /^tfa!(.*)$/) {
459 # TOTP and Yubico don't require a challenge so this is the generic
460 # 'missing 2nd factor ticket'
462 $tfa_info = { type
=> 'tfa' };
464 # Regular ticket (full access)
468 return undef if !PVE
::Auth
::Plugin
::verify_username
($username, $noerr);
470 return wantarray ?
($username, $age, $tfa_info) : $username;
474 my ($api_token) = @_;
476 die "no API token specified\n" if !$api_token;
478 my ($tokenid, $value);
479 if ($api_token =~ /^(.*)=(.*)$/) {
483 die "no tokenid specified\n";
486 my ($username, $token) = split_tokenid
($tokenid);
488 my $usercfg = cfs_read_file
('user.cfg');
489 check_user_enabled
($usercfg, $username);
490 check_token_exist
($usercfg, $username, $token);
492 my $user = $usercfg->{users
}->{$username};
493 my $token_info = $user->{tokens
}->{$token};
496 die "token '$token' access expired\n" if $token_info->{expire
} && ($token_info->{expire
} < $ctime);
498 die "invalid token value!\n" if !PVE
::Cluster
::verify_token
($tokenid, $value);
500 return wantarray ?
($tokenid) : $tokenid;
503 my $assemble_short_lived_ticket = sub {
504 my ($prefix, $username, $path) = @_;
506 my $rsa_priv = get_privkey
();
508 $path = normalize_path
($path);
510 die "invalid ticket path\n" if !defined($path);
512 my $secret_data = "$username:$path";
514 return PVE
::Ticket
::assemble_rsa_ticket
(
515 $rsa_priv, $prefix, undef, $secret_data);
518 my $verify_short_lived_ticket = sub {
519 my ($ticket, $prefix, $username, $path, $noerr) = @_;
521 $path = normalize_path
($path);
523 die "invalid ticket path\n" if !defined($path);
525 my $secret_data = "$username:$path";
527 my ($rsa_pub, $rsa_mtime) = get_pubkey
();
528 if (!$rsa_pub || (time() - $rsa_mtime > $authkey_lifetime && $authkey_lifetime > 0)) {
532 # raise error via undef ticket
533 PVE
::Ticket
::verify_rsa_ticket
($rsa_pub, $prefix);
537 return PVE
::Ticket
::verify_rsa_ticket
(
538 $rsa_pub, $prefix, $ticket, $secret_data, -20, 40, $noerr);
542 # - they do not contain the username in plain text
543 # - they are restricted to a specific resource path (example: '/vms/100')
544 sub assemble_vnc_ticket
{
545 my ($username, $path) = @_;
547 return $assemble_short_lived_ticket->('PVEVNC', $username, $path);
550 sub verify_vnc_ticket
{
551 my ($ticket, $username, $path, $noerr) = @_;
553 return $verify_short_lived_ticket->($ticket, 'PVEVNC', $username, $path, $noerr);
557 # - they do not contain the username in plain text
558 # - they are restricted to a specific resource path (example: '/vms/100', '/socket/run/qemu-server/123.storage')
559 sub assemble_tunnel_ticket
{
560 my ($username, $path) = @_;
562 return $assemble_short_lived_ticket->('PVETUNNEL', $username, $path);
565 sub verify_tunnel_ticket
{
566 my ($ticket, $username, $path, $noerr) = @_;
568 return $verify_short_lived_ticket->($ticket, 'PVETUNNEL', $username, $path, $noerr);
571 sub assemble_spice_ticket
{
572 my ($username, $vmid, $node) = @_;
574 my $secret = &$get_csrfr_secret();
576 return PVE
::Ticket
::assemble_spice_ticket
(
577 $secret, $username, $vmid, $node);
580 sub verify_spice_connect_url
{
581 my ($connect_str) = @_;
583 my $secret = &$get_csrfr_secret();
585 return PVE
::Ticket
::verify_spice_connect_url
($secret, $connect_str);
588 sub read_x509_subject_spice
{
592 my $bio = Net
::SSLeay
::BIO_new_file
($filename, 'r');
593 die "Could not open $filename using OpenSSL\n"
596 my $x509 = Net
::SSLeay
::PEM_read_bio_X509
($bio);
597 Net
::SSLeay
::BIO_free
($bio);
599 die "Could not parse X509 certificate in $filename\n"
602 my $nameobj = Net
::SSLeay
::X509_get_subject_name
($x509);
603 my $subject = Net
::SSLeay
::X509_NAME_oneline
($nameobj);
604 Net
::SSLeay
::X509_free
($x509);
606 # remote-viewer wants comma as separator (not '/')
608 $subject =~ s!/(\w+=)!,$1!g;
613 # helper to generate SPICE remote-viewer configuration
614 sub remote_viewer_config
{
615 my ($authuser, $vmid, $node, $proxy, $title, $port) = @_;
618 my $host = `hostname -f` || PVE
::INotify
::nodename
();
623 my ($ticket, $proxyticket) = assemble_spice_ticket
($authuser, $vmid, $node);
625 my $filename = "/etc/pve/local/pve-ssl.pem";
626 my $subject = read_x509_subject_spice
($filename);
628 my $cacert = PVE
::Tools
::file_get_contents
("/etc/pve/pve-root-ca.pem", 8192);
629 $cacert =~ s/\n/\\n/g;
631 $proxy = "[$proxy]" if Net
::IP
::ip_is_ipv6
($proxy);
633 'secure-attention' => "Ctrl+Alt+Ins",
634 'toggle-fullscreen' => "Shift+F11",
635 'release-cursor' => "Ctrl+Alt+R",
638 host
=> $proxyticket, # this breaks tls hostname verification, so we need to use 'host-subject'
639 proxy
=> "http://$proxy:3128",
641 'host-subject' => $subject,
644 'delete-this-file' => 1,
647 return ($ticket, $proxyticket, $config);
650 sub check_user_exist
{
651 my ($usercfg, $username, $noerr) = @_;
653 $username = PVE
::Auth
::Plugin
::verify_username
($username, $noerr);
654 return undef if !$username;
656 return $usercfg->{users
}->{$username} if $usercfg && $usercfg->{users
}->{$username};
658 die "no such user ('$username')\n" if !$noerr;
663 sub check_user_enabled
{
664 my ($usercfg, $username, $noerr) = @_;
666 my $data = check_user_exist
($usercfg, $username, $noerr);
667 return undef if !$data;
669 if (!$data->{enable
}) {
670 die "user '$username' is disabled\n" if !$noerr;
675 my $expire = $usercfg->{users
}->{$username}->{expire
};
677 if ($expire && $expire < $ctime) {
678 die "user '$username' access expired\n" if !$noerr;
682 return 1; # enabled and not expired
685 sub check_token_exist
{
686 my ($usercfg, $username, $tokenid, $noerr) = @_;
688 my $user = check_user_exist
($usercfg, $username, $noerr);
689 return undef if !$user;
691 return $user->{tokens
}->{$tokenid}
692 if defined($user->{tokens
}) && $user->{tokens
}->{$tokenid};
694 die "no such token '$tokenid' for user '$username'\n" if !$noerr;
700 sub verify_one_time_pw
{
701 my ($type, $username, $keys, $tfa_cfg, $otp) = @_;
703 die "missing one time password for two-factor authentication '$type'\n" if !$otp;
705 # fixme: proxy support?
708 if ($type eq 'yubico') {
709 PVE
::OTP
::yubico_verify_otp
($otp, $keys, $tfa_cfg->{url
},
710 $tfa_cfg->{id
}, $tfa_cfg->{key
}, $proxy);
711 } elsif ($type eq 'oath') {
712 PVE
::OTP
::oath_verify_otp
($otp, $keys, $tfa_cfg->{step
}, $tfa_cfg->{digits
});
714 die "unknown tfa type '$type'\n";
718 # password should be utf8 encoded
719 # Note: some plugins delay/sleep if auth fails
720 sub authenticate_user
: prototype($$$;$) {
721 my ($username, $password, $otp, $tfa_challenge) = @_;
723 die "no username specified\n" if !$username;
727 ($username, $ruid, $realm) = PVE
::Auth
::Plugin
::verify_username
($username);
729 my $usercfg = cfs_read_file
('user.cfg');
731 check_user_enabled
($usercfg, $username);
733 my $domain_cfg = cfs_read_file
('domains.cfg');
735 my $cfg = $domain_cfg->{ids
}->{$realm};
736 die "auth domain '$realm' does not exist\n" if !$cfg;
737 my $plugin = PVE
::Auth
::Plugin-
>lookup($cfg->{type
});
739 if ($tfa_challenge) {
740 # This is the 2nd factor, use the password for the OTP response.
741 my $tfa_challenge = authenticate_2nd_new
($username, $realm, $password, $tfa_challenge);
742 return wantarray ?
($username, $tfa_challenge) : $username;
745 $plugin->authenticate_user($cfg, $realm, $ruid, $password);
747 # This is the first factor with an optional immediate 2nd factor for TOTP:
748 $tfa_challenge = authenticate_2nd_new
($username, $realm, $otp, undef);
749 return wantarray ?
($username, $tfa_challenge) : $username;
752 sub authenticate_2nd_new_do
: prototype($$$$) {
753 my ($username, $realm, $tfa_response, $tfa_challenge) = @_;
754 my ($tfa_cfg, $realm_tfa) = user_get_tfa
($username, $realm);
756 if (!defined($tfa_cfg)) {
760 my $realm_type = $realm_tfa && $realm_tfa->{type
};
761 # verify realm type unless using recovery keys:
762 if (defined($realm_type)) {
763 $realm_type = 'totp' if $realm_type eq 'oath'; # we used to call it that
764 if ($realm_type eq 'yubico') {
765 # Yubico auth will not be supported in rust for now...
766 if (!defined($tfa_challenge)) {
767 my $challenge = { yubico
=> JSON
::true
};
768 # Even with yubico auth we do allow recovery keys to be used:
769 if (my $recovery = $tfa_cfg->recovery_state($username)) {
770 $challenge->{recovery
} = $recovery;
772 return to_json
($challenge);
775 if ($tfa_response =~ /^yubico:(.*)$/) {
777 # Defer to after unlocking the TFA config:
779 authenticate_yubico_new
(
780 $tfa_cfg, $username, $realm_tfa, $tfa_challenge, $tfa_response,
787 if (defined($tfa_response)) {
788 if ($tfa_response !~ /^([^:]+):/) {
789 die "bad otp response\n";
794 die "realm requires $realm_type authentication\n"
795 if $response_type && $response_type ne 'recovery' && $response_type ne $realm_type;
798 configure_u2f_and_wa
($tfa_cfg);
800 my ($result, $tfa_done);
801 if (defined($tfa_challenge)) {
803 $tfa_challenge = verify_ticket
($tfa_challenge, 0, $username);
804 $result = $tfa_cfg->authentication_verify2($username, $tfa_challenge, $tfa_response);
805 $tfa_challenge = undef;
807 $tfa_challenge = $tfa_cfg->authentication_challenge($username);
808 if (defined($tfa_response)) {
809 if (defined($tfa_challenge)) {
811 $result = $tfa_cfg->authentication_verify2($username, $tfa_challenge, $tfa_response);
813 die "no such challenge\n";
820 # authentication_verify2 somehow returned undef - should be unreachable
821 die "2nd factor failed\n";
824 if ($result->{'needs-saving'}) {
825 cfs_write_file
('priv/tfa.cfg', $tfa_cfg);
827 if ($result->{'totp-limit-reached'}) {
828 # FIXME: send mail to the user (or admin/root if no email configured)
829 die "failed 2nd factor: TOTP limit reached, locked\n";
831 if ($result->{'tfa-limit-reached'}) {
832 # FIXME: send mail to the user (or admin/root if no email configured)
833 die "failed 1nd factor: TFA limit reached, user locked out\n";
835 if (!$result->{result
}) {
836 die "failed 2nd factor\n";
840 return $tfa_challenge;
843 # Returns a tfa challenge or undef.
844 sub authenticate_2nd_new
: prototype($$$$) {
845 my ($username, $realm, $tfa_response, $tfa_challenge) = @_;
849 if (defined($tfa_response) && $tfa_response =~ m/^recovery:/) {
850 $result = lock_tfa_config
(sub {
851 authenticate_2nd_new_do
($username, $realm, $tfa_response, $tfa_challenge);
854 $result = authenticate_2nd_new_do
($username, $realm, $tfa_response, $tfa_challenge);
857 # Yubico auth returns the authentication sub:
858 if (ref($result) eq 'CODE') {
859 $result = $result->();
865 sub authenticate_yubico_new
: prototype($$$) {
866 my ($tfa_cfg, $username, $realm, $tfa_challenge, $otp) = @_;
868 $tfa_challenge = verify_ticket
($tfa_challenge, 0, $username);
869 $tfa_challenge = from_json
($tfa_challenge);
871 if (!$tfa_challenge->{yubico
}) {
872 die "no such challenge\n";
875 my $keys = $tfa_cfg->get_yubico_keys($username);
876 die "no keys configured\n" if !defined($keys) || !length($keys);
878 authenticate_yubico_do
($otp, $keys, $realm);
880 # return `undef` to clear the tfa challenge.
884 sub authenticate_yubico_do
: prototype($$$) {
885 my ($value, $keys, $realm) = @_;
887 # fixme: proxy support?
890 PVE
::OTP
::yubico_verify_otp
($value, $keys, $realm->{url
}, $realm->{id
}, $realm->{key
}, $proxy);
893 sub configure_u2f_and_wa
: prototype($) {
897 my $get_origin = sub {
898 return $rpc_origin if defined($rpc_origin);
899 my $rpcenv = PVE
::RPCEnvironment
::get
();
900 if (my $origin = $rpcenv->get_request_host(1)) {
901 $rpc_origin = "https://$origin";
904 die "failed to figure out origin\n";
907 my $dc = cfs_read_file
('datacenter.cfg');
908 if (my $u2f = $dc->{u2f
}) {
910 $tfa_cfg->set_u2f_config({
911 origin
=> $u2f->{origin
} // $get_origin->(),
912 appid
=> $u2f->{appid
},
915 warn "u2f unavailable, configuration error: $@\n" if $@;
917 if (my $wa = $dc->{webauthn
}) {
918 $wa->{origin
} //= $get_origin->();
919 eval { $tfa_cfg->set_webauthn_config({%$wa}) };
920 warn "webauthn unavailable, configuration error: $@\n" if $@;
924 sub domain_set_password
{
925 my ($realm, $username, $password) = @_;
927 die "no auth domain specified" if !$realm;
929 my $domain_cfg = cfs_read_file
('domains.cfg');
931 my $cfg = $domain_cfg->{ids
}->{$realm};
932 die "auth domain '$realm' does not exist\n" if !$cfg;
933 my $plugin = PVE
::Auth
::Plugin-
>lookup($cfg->{type
});
934 $plugin->store_password($cfg, $realm, $username, $password);
937 sub iterate_acl_tree
{
938 my ($path, $node, $code) = @_;
940 $code->($path, $node);
942 $path = '' if $path eq '/'; # avoid leading '//'
944 my $children = $node->{children
};
946 foreach my $child (keys %$children) {
947 iterate_acl_tree
("$path/$child", $children->{$child}, $code);
951 # find ACL node corresponding to normalized $path under $root
952 sub find_acl_tree_node
{
953 my ($root, $path) = @_;
955 my $split_path = [ split("/", $path) ];
962 for my $p (@$split_path) {
965 $node->{children
} = {} if !$node->{children
};
966 $node->{children
}->{$p} = {} if !$node->{children
}->{$p};
968 $node = $node->{children
}->{$p};
975 my ($username, $usercfg, $group) = @_;
977 $usercfg->{users
}->{$username}->{groups
}->{$group} = 1;
978 $usercfg->{groups
}->{$group}->{users
}->{$username} = 1;
981 sub delete_user_group
{
982 my ($username, $usercfg) = @_;
984 foreach my $group (keys %{$usercfg->{groups
}}) {
986 delete ($usercfg->{groups
}->{$group}->{users
}->{$username})
987 if $usercfg->{groups
}->{$group}->{users
}->{$username};
991 sub delete_user_acl
{
992 my ($username, $usercfg) = @_;
995 my ($path, $acl_node) = @_;
997 delete ($acl_node->{users
}->{$username})
998 if $acl_node->{users
}->{$username};
1001 iterate_acl_tree
("/", $usercfg->{acl_root
}, $code);
1004 sub delete_group_acl
{
1005 my ($group, $usercfg) = @_;
1008 my ($path, $acl_node) = @_;
1010 delete ($acl_node->{groups
}->{$group})
1011 if $acl_node->{groups
}->{$group};
1014 iterate_acl_tree
("/", $usercfg->{acl_root
}, $code);
1017 sub delete_pool_acl
{
1018 my ($pool, $usercfg) = @_;
1020 delete ($usercfg->{acl_root
}->{children
}->{pool
}->{children
}->{$pool});
1023 # we automatically create some predefined roles by splitting privs
1024 # into 3 groups (per category)
1025 # root: only root is allowed to do that
1026 # admin: an administrator can to that
1027 # user: a normal user/customer can to that
1035 'VM.Config.Network',
1037 'VM.Config.Options', # covers all other things
1043 'VM.Snapshot.Rollback',
1046 'VM.Config.CDROM', # change CDROM media
1047 'VM.Config.Cloudinit',
1059 'Sys.Modify', # edit/change node settings
1060 'Sys.Incoming', # incoming storage/guest migrations
1074 'Datastore.Allocate',
1075 'Datastore.AllocateTemplate',
1078 'Datastore.AllocateSpace',
1103 'Group.Allocate', # edit/change group settings
1104 'Realm.AllocateUser',
1112 'Pool.Allocate', # create/delete pools
1124 'Permissions.Modify' => 1, # not contained in a group
1127 my $special_roles = {
1128 'NoAccess' => {}, # no privileges
1129 'Administrator' => $valid_privs, # all privileges
1134 foreach my $cat (keys %$privgroups) {
1135 my $cd = $privgroups->{$cat};
1136 foreach my $p (@{$cd->{root
}}, @{$cd->{admin
}},
1137 @{$cd->{user
}}, @{$cd->{audit
}}) {
1138 $valid_privs->{$p} = 1;
1140 foreach my $p (@{$cd->{admin
}}, @{$cd->{user
}}, @{$cd->{audit
}}) {
1142 $special_roles->{"PVE${cat}Admin"}->{$p} = 1;
1143 $special_roles->{"PVEAdmin"}->{$p} = 1;
1145 if (scalar(@{$cd->{user
}})) {
1146 foreach my $p (@{$cd->{user
}}, @{$cd->{audit
}}) {
1147 $special_roles->{"PVE${cat}User"}->{$p} = 1;
1150 foreach my $p (@{$cd->{audit
}}) {
1151 $special_roles->{"PVEAuditor"}->{$p} = 1;
1155 $special_roles->{"PVETemplateUser"} = { 'VM.Clone' => 1, 'VM.Audit' => 1 };
1160 sub create_priv_properties
{
1161 my $properties = {};
1162 foreach my $priv (keys %$valid_privs) {
1163 $properties->{$priv} = {
1171 sub role_is_special
{
1173 return (exists $special_roles->{$role}) ?
1 : 0;
1176 sub add_role_privs
{
1177 my ($role, $usercfg, $privs) = @_;
1181 die "role '$role' does not exist\n" if !$usercfg->{roles
}->{$role};
1183 foreach my $priv (split_list
($privs)) {
1184 if (defined ($valid_privs->{$priv})) {
1185 $usercfg->{roles
}->{$role}->{$priv} = 1;
1187 die "invalid privilege '$priv'\n";
1192 sub lookup_username
{
1193 my ($username, $noerr) = @_;
1195 $username =~ m!^(${PVE::Auth::Plugin::user_regex})\@(${PVE::Auth::Plugin::realm_regex})$!;
1198 my $domain_cfg = cfs_read_file
("domains.cfg");
1199 my $casesensitive = $domain_cfg->{ids
}->{$realm}->{'case-sensitive'} // 1;
1200 my $usercfg = cfs_read_file
('user.cfg');
1202 if (!$casesensitive) {
1203 my @matches = grep { lc $username eq lc $_ } (keys %{$usercfg->{users
}});
1205 die "ambiguous case insensitive match of username '$username', cannot safely grant access!\n"
1206 if scalar @matches > 1 && !$noerr;
1214 sub normalize_path
{
1217 return undef if !$path;
1223 $path = '/' if !$path;
1225 $path = "/$path" if $path !~ m
|^/|;
1227 return undef if $path !~ m
|^[[:alnum
:]\
.\
-\_\
/]+$|;
1234 return $path =~ m
!^(
1238 |/access/groups
/[[:alnum
:]\
.\
-\_
]+
1240 |/access/realm
/[[:alnum
:]\
.\
-\_
]+
1242 |/nodes/[[:alnum
:]\
.\
-\_
]+
1244 |/pool/[[:alnum
:]\
.\
-\_
]+
1247 |/sdn/zones
/[[:alnum
:]\
.\
-\_
]+
1248 |/sdn/zones
/[[:alnum:]\.\-\_]+/[[:alnum
:]\
.\
-\_
]+
1249 |/sdn/zones
/[[:alnum
:]\
.\
-\_
]+/[[:alnum
:]\
.\
-\_
]+/[1-9][0-9]{0,3}
1251 |/storage/[[:alnum
:]\
.\
-\_
]+
1253 |/vms/[1-9][0-9]{2,}
1257 PVE
::JSONSchema
::register_format
('pve-groupid', \
&verify_groupname
);
1258 sub verify_groupname
{
1259 my ($groupname, $noerr) = @_;
1261 if ($groupname !~ m/^[A-Za-z0-9\.\-_]+$/) {
1263 die "group name '$groupname' contains invalid characters\n" if !$noerr;
1271 PVE
::JSONSchema
::register_format
('pve-roleid', \
&verify_rolename
);
1272 sub verify_rolename
{
1273 my ($rolename, $noerr) = @_;
1275 if ($rolename !~ m/^[A-Za-z0-9\.\-_]+$/) {
1277 die "role name '$rolename' contains invalid characters\n" if !$noerr;
1285 PVE
::JSONSchema
::register_format
('pve-poolid', \
&verify_poolname
);
1286 sub verify_poolname
{
1287 my ($poolname, $noerr) = @_;
1289 if ($poolname !~ m/^[A-Za-z0-9\.\-_]+$/) {
1291 die "pool name '$poolname' contains invalid characters\n" if !$noerr;
1299 PVE
::JSONSchema
::register_format
('pve-priv', \
&verify_privname
);
1300 sub verify_privname
{
1301 my ($priv, $noerr) = @_;
1303 if (!$valid_privs->{$priv}) {
1304 die "invalid privilege '$priv'\n" if !$noerr;
1312 sub userconfig_force_defaults
{
1315 foreach my $r (keys %$special_roles) {
1316 $cfg->{roles
}->{$r} = $special_roles->{$r};
1319 # add root user if not exists
1320 if (!$cfg->{users
}->{'root@pam'}) {
1321 $cfg->{users
}->{'root@pam'}->{enable
} = 1;
1324 # add (empty) ACL tree root node
1325 if (!$cfg->{acl_root
}) {
1326 $cfg->{acl_root
} = {};
1330 sub parse_user_config
{
1331 my ($filename, $raw) = @_;
1335 userconfig_force_defaults
($cfg);
1337 $raw = '' if !defined($raw);
1338 while ($raw =~ /^\s*(.+?)\s*$/gm) {
1342 foreach my $d (split (/:/, $line)) {
1348 my $et = shift @data;
1350 if ($et eq 'user') {
1351 my ($user, $enable, $expire, $firstname, $lastname, $email, $comment, $keys) = @data;
1353 my (undef, undef, $realm) = PVE
::Auth
::Plugin
::verify_username
($user, 1);
1355 warn "user config - ignore user '$user' - invalid user name\n";
1359 $enable = $enable ?
1 : 0;
1361 $expire = 0 if !$expire;
1363 if ($expire !~ m/^\d+$/) {
1364 warn "user config - ignore user '$user' - (illegal characters in expire '$expire')\n";
1367 $expire = int($expire);
1369 #if (!verify_groupname ($group, 1)) {
1370 # warn "user config - ignore user '$user' - invalid characters in group name\n";
1374 $cfg->{users
}->{$user} = {
1378 $cfg->{users
}->{$user}->{firstname
} = PVE
::Tools
::decode_text
($firstname) if $firstname;
1379 $cfg->{users
}->{$user}->{lastname
} = PVE
::Tools
::decode_text
($lastname) if $lastname;
1380 $cfg->{users
}->{$user}->{email
} = $email;
1381 $cfg->{users
}->{$user}->{comment
} = PVE
::Tools
::decode_text
($comment) if $comment;
1382 $cfg->{users
}->{$user}->{expire
} = $expire;
1383 # keys: allowed yubico key ids or oath secrets (base32 encoded)
1384 $cfg->{users
}->{$user}->{keys} = $keys if $keys;
1386 #$cfg->{users}->{$user}->{groups}->{$group} = 1;
1387 #$cfg->{groups}->{$group}->{$user} = 1;
1389 } elsif ($et eq 'group') {
1390 my ($group, $userlist, $comment) = @data;
1392 if (!verify_groupname
($group, 1)) {
1393 warn "user config - ignore group '$group' - invalid characters in group name\n";
1397 # make sure to add the group (even if there are no members)
1398 $cfg->{groups
}->{$group} = { users
=> {} } if !$cfg->{groups
}->{$group};
1400 $cfg->{groups
}->{$group}->{comment
} = PVE
::Tools
::decode_text
($comment) if $comment;
1402 foreach my $user (split_list
($userlist)) {
1404 if (!PVE
::Auth
::Plugin
::verify_username
($user, 1)) {
1405 warn "user config - ignore invalid group member '$user'\n";
1409 if ($cfg->{users
}->{$user}) { # user exists
1410 $cfg->{users
}->{$user}->{groups
}->{$group} = 1;
1412 warn "user config - ignore invalid group member '$user'\n";
1414 $cfg->{groups
}->{$group}->{users
}->{$user} = 1;
1417 } elsif ($et eq 'role') {
1418 my ($role, $privlist) = @data;
1420 if (!verify_rolename
($role, 1)) {
1421 warn "user config - ignore role '$role' - invalid characters in role name\n";
1425 # make sure to add the role (even if there are no privileges)
1426 $cfg->{roles
}->{$role} = {} if !$cfg->{roles
}->{$role};
1428 foreach my $priv (split_list
($privlist)) {
1429 if (defined ($valid_privs->{$priv})) {
1430 $cfg->{roles
}->{$role}->{$priv} = 1;
1432 warn "user config - ignore invalid privilege '$priv'\n";
1436 } elsif ($et eq 'acl') {
1437 my ($propagate, $pathtxt, $uglist, $rolelist) = @data;
1439 $propagate = $propagate ?
1 : 0;
1441 if (my $path = normalize_path
($pathtxt)) {
1443 foreach my $role (split_list
($rolelist)) {
1445 if (!verify_rolename
($role, 1)) {
1446 warn "user config - ignore invalid role name '$role' in acl\n";
1450 if (!$cfg->{roles
}->{$role}) {
1451 warn "user config - ignore invalid acl role '$role'\n";
1455 foreach my $ug (split_list
($uglist)) {
1456 my ($group) = $ug =~ m/^@(\S+)$/;
1458 if ($group && verify_groupname
($group, 1)) {
1459 if (!$cfg->{groups
}->{$group}) { # group does not exist
1460 warn "user config - ignore invalid acl group '$group'\n";
1462 $acl_node = find_acl_tree_node
($cfg->{acl_root
}, $path) if !$acl_node;
1463 $acl_node->{groups
}->{$group}->{$role} = $propagate;
1464 } elsif (PVE
::Auth
::Plugin
::verify_username
($ug, 1)) {
1465 if (!$cfg->{users
}->{$ug}) { # user does not exist
1466 warn "user config - ignore invalid acl member '$ug'\n";
1468 $acl_node = find_acl_tree_node
($cfg->{acl_root
}, $path) if !$acl_node;
1469 $acl_node->{users
}->{$ug}->{$role} = $propagate;
1470 } elsif (my ($user, $token) = split_tokenid
($ug, 1)) {
1471 if (check_token_exist
($cfg, $user, $token, 1)) {
1472 $acl_node = find_acl_tree_node
($cfg->{acl_root
}, $path) if !$acl_node;
1473 $acl_node->{tokens
}->{$ug}->{$role} = $propagate;
1475 warn "user config - ignore invalid acl token '$ug'\n";
1478 warn "user config - invalid user/group '$ug' in acl\n";
1483 warn "user config - ignore invalid path in acl '$pathtxt'\n";
1485 } elsif ($et eq 'pool') {
1486 my ($pool, $comment, $vmlist, $storelist) = @data;
1488 if (!verify_poolname
($pool, 1)) {
1489 warn "user config - ignore pool '$pool' - invalid characters in pool name\n";
1493 # make sure to add the pool (even if there are no members)
1494 $cfg->{pools
}->{$pool} = { vms
=> {}, storage
=> {} } if !$cfg->{pools
}->{$pool};
1496 $cfg->{pools
}->{$pool}->{comment
} = PVE
::Tools
::decode_text
($comment) if $comment;
1498 foreach my $vmid (split_list
($vmlist)) {
1499 if ($vmid !~ m/^\d+$/) {
1500 warn "user config - ignore invalid vmid '$vmid' in pool '$pool'\n";
1505 if ($cfg->{vms
}->{$vmid}) {
1506 warn "user config - ignore duplicate vmid '$vmid' in pool '$pool'\n";
1510 $cfg->{pools
}->{$pool}->{vms
}->{$vmid} = 1;
1512 # record vmid ==> pool relation
1513 $cfg->{vms
}->{$vmid} = $pool;
1516 foreach my $storeid (split_list
($storelist)) {
1517 if ($storeid !~ m/^[a-z][a-z0-9\-\_\.]*[a-z0-9]$/i) {
1518 warn "user config - ignore invalid storage '$storeid' in pool '$pool'\n";
1521 $cfg->{pools
}->{$pool}->{storage
}->{$storeid} = 1;
1523 } elsif ($et eq 'token') {
1524 my ($tokenid, $expire, $privsep, $comment) = @data;
1526 my ($user, $token) = split_tokenid
($tokenid, 1);
1527 if (!($user && $token)) {
1528 warn "user config - ignore invalid tokenid '$tokenid'\n";
1532 $privsep = $privsep ?
1 : 0;
1534 $expire = 0 if !$expire;
1536 if ($expire !~ m/^\d+$/) {
1537 warn "user config - ignore token '$tokenid' - (illegal characters in expire '$expire')\n";
1540 $expire = int($expire);
1542 if (my $user_cfg = $cfg->{users
}->{$user}) { # user exists
1543 $user_cfg->{tokens
}->{$token} = {} if !$user_cfg->{tokens
}->{$token};
1544 my $token_cfg = $user_cfg->{tokens
}->{$token};
1545 $token_cfg->{privsep
} = $privsep;
1546 $token_cfg->{expire
} = $expire;
1547 $token_cfg->{comment
} = PVE
::Tools
::decode_text
($comment) if $comment;
1549 warn "user config - ignore token '$tokenid' - user does not exist\n";
1552 warn "user config - ignore config line: $line\n";
1556 userconfig_force_defaults
($cfg);
1561 sub write_user_config
{
1562 my ($filename, $cfg) = @_;
1566 foreach my $user (sort keys %{$cfg->{users
}}) {
1567 my $d = $cfg->{users
}->{$user};
1568 my $firstname = $d->{firstname
} ? PVE
::Tools
::encode_text
($d->{firstname
}) : '';
1569 my $lastname = $d->{lastname
} ? PVE
::Tools
::encode_text
($d->{lastname
}) : '';
1570 my $email = $d->{email
} || '';
1571 my $comment = $d->{comment
} ? PVE
::Tools
::encode_text
($d->{comment
}) : '';
1572 my $expire = int($d->{expire
} || 0);
1573 my $enable = $d->{enable
} ?
1 : 0;
1574 my $keys = $d->{keys} ?
$d->{keys} : '';
1575 $data .= "user:$user:$enable:$expire:$firstname:$lastname:$email:$comment:$keys:\n";
1577 my $user_tokens = $d->{tokens
};
1578 foreach my $token (sort keys %$user_tokens) {
1579 my $td = $user_tokens->{$token};
1580 my $full_tokenid = join_tokenid
($user, $token);
1581 my $comment = $td->{comment
} ? PVE
::Tools
::encode_text
($td->{comment
}) : '';
1582 my $expire = int($td->{expire
} || 0);
1583 my $privsep = $td->{privsep
} ?
1 : 0;
1584 $data .= "token:$full_tokenid:$expire:$privsep:$comment:\n";
1590 foreach my $group (sort keys %{$cfg->{groups
}}) {
1591 my $d = $cfg->{groups
}->{$group};
1592 my $list = join (',', sort keys %{$d->{users
}});
1593 my $comment = $d->{comment
} ? PVE
::Tools
::encode_text
($d->{comment
}) : '';
1594 $data .= "group:$group:$list:$comment:\n";
1599 foreach my $pool (sort keys %{$cfg->{pools
}}) {
1600 my $d = $cfg->{pools
}->{$pool};
1601 my $vmlist = join (',', sort keys %{$d->{vms
}});
1602 my $storelist = join (',', sort keys %{$d->{storage
}});
1603 my $comment = $d->{comment
} ? PVE
::Tools
::encode_text
($d->{comment
}) : '';
1604 $data .= "pool:$pool:$comment:$vmlist:$storelist:\n";
1609 foreach my $role (sort keys %{$cfg->{roles
}}) {
1610 next if $special_roles->{$role};
1612 my $d = $cfg->{roles
}->{$role};
1613 my $list = join (',', sort keys %$d);
1614 $data .= "role:$role:$list:\n";
1619 my $collect_rolelist_members = sub {
1620 my ($acl_members, $result, $prefix, $exclude) = @_;
1622 foreach my $member (keys %$acl_members) {
1623 next if $exclude && $member eq $exclude;
1627 foreach my $role (sort keys %{$acl_members->{$member}}) {
1628 my $propagate = $acl_members->{$member}->{$role};
1637 $result->{0}->{$l0}->{"${prefix}${member}"} = 1 if $l0;
1638 $result->{1}->{$l1}->{"${prefix}${member}"} = 1 if $l1;
1642 iterate_acl_tree
("/", $cfg->{acl_root
}, sub {
1643 my ($path, $d) = @_;
1645 my $rolelist_members = {};
1647 $collect_rolelist_members->($d->{'groups'}, $rolelist_members, '@');
1649 # no need to save 'root@pam', it is always 'Administrator'
1650 $collect_rolelist_members->($d->{'users'}, $rolelist_members, '', 'root@pam');
1652 $collect_rolelist_members->($d->{'tokens'}, $rolelist_members, '');
1654 foreach my $propagate (0,1) {
1655 my $filtered = $rolelist_members->{$propagate};
1656 foreach my $rolelist (sort keys %$filtered) {
1657 my $uglist = join (',', sort keys %{$filtered->{$rolelist}});
1658 $data .= "acl:$propagate:$path:$uglist:$rolelist:\n";
1667 # Creates a `PVE::RS::TFA` instance from the raw config data.
1668 # Its contained hash will also support the legacy functionality.
1669 sub parse_priv_tfa_config
{
1670 my ($filename, $raw) = @_;
1672 $raw = '' if !defined($raw);
1673 my $cfg = PVE
::RS
::TFA-
>new($raw);
1675 # Purge invalid users:
1676 foreach my $user ($cfg->users()->@*) {
1677 my (undef, undef, $realm) = PVE
::Auth
::Plugin
::verify_username
($user, 1);
1679 warn "user tfa config - ignore user '$user' - invalid user name\n";
1680 $cfg->remove_user($user);
1687 sub write_priv_tfa_config
{
1688 my ($filename, $cfg) = @_;
1690 assert_new_tfa_config_available
();
1692 return $cfg->write();
1696 my ($cfg, $user, $path) = @_;
1698 # NOTE: we do not consider pools here.
1699 # NOTE: for privsep tokens, this does not filter roles by those that the
1700 # corresponding user has.
1701 # Use $rpcenv->permission() for any actual permission checks!
1703 return 'Administrator' if $user eq 'root@pam'; # root can do anything
1705 if (!defined($path)) {
1706 # this shouldn't happen!
1707 warn "internal error: ACL check called for undefined ACL path!\n";
1711 if (pve_verify_tokenid
($user, 1)) {
1712 my $tokenid = $user;
1713 my ($username, $token) = split_tokenid
($tokenid);
1715 my $token_info = $cfg->{users
}->{$username}->{tokens
}->{$token};
1716 return () if !$token_info;
1718 my $user_roles = roles
($cfg, $username, $path);
1720 # return full user privileges
1721 return $user_roles if !$token_info->{privsep
};
1726 my $split = [ split("/", $path) ];
1731 my $acl = $cfg->{acl_root
};
1735 my $p = shift @$split;
1736 my $final = !@$split;
1738 $acl = $acl->{children
}->{$p};
1741 #print "CHECKACL $path $p\n";
1742 #print "ACL $path = " . Dumper ($acl);
1743 if (my $ri = $acl->{tokens
}->{$user}) {
1745 foreach my $role (keys %$ri) {
1746 my $propagate = $ri->{$role};
1747 if ($final || $propagate) {
1748 #print "APPLY ROLE $p $user $role\n";
1750 $new->{$role} = $propagate;
1754 $roles = $new; # overwrite previous settings
1759 if (my $ri = $acl->{users
}->{$user}) {
1761 foreach my $role (keys %$ri) {
1762 my $propagate = $ri->{$role};
1763 if ($final || $propagate) {
1764 #print "APPLY ROLE $p $user $role\n";
1766 $new->{$role} = $propagate;
1770 $roles = $new; # overwrite previous settings
1771 next; # user privs always override group privs
1776 foreach my $g (keys %{$acl->{groups
}}) {
1777 next if !$cfg->{groups
}->{$g}->{users
}->{$user};
1778 if (my $ri = $acl->{groups
}->{$g}) {
1779 foreach my $role (keys %$ri) {
1780 my $propagate = $ri->{$role};
1781 if ($final || $propagate) {
1782 #print "APPLY ROLE $p \@$g $role\n";
1784 $new->{$role} = $propagate;
1790 $roles = $new; # overwrite previous settings
1795 return { 'NoAccess' => $roles->{NoAccess
} } if defined ($roles->{NoAccess
});
1796 #return () if defined ($roles->{NoAccess});
1798 #print "permission $user $path = " . Dumper ($roles);
1800 #print "roles $user $path = " . join (',', @ra) . "\n";
1805 sub remove_vm_access
{
1807 my $delVMaccessFn = sub {
1808 my $usercfg = cfs_read_file
("user.cfg");
1811 if (my $acl = $usercfg->{acl_root
}->{children
}->{vms
}->{children
}->{$vmid}) {
1812 delete $usercfg->{acl_root
}->{children
}->{vms
}->{children
}->{$vmid};
1815 if (my $pool = $usercfg->{vms
}->{$vmid}) {
1816 if (my $data = $usercfg->{pools
}->{$pool}) {
1817 delete $data->{vms
}->{$vmid};
1818 delete $usercfg->{vms
}->{$vmid};
1822 cfs_write_file
("user.cfg", $usercfg) if $modified;
1825 lock_user_config
($delVMaccessFn, "access permissions cleanup for VM $vmid failed");
1828 sub remove_storage_access
{
1831 my $deleteStorageAccessFn = sub {
1832 my $usercfg = cfs_read_file
("user.cfg");
1835 if (my $acl = $usercfg->{acl_root
}->{children
}->{storage
}->{children
}->{$storeid}) {
1836 delete $usercfg->{acl_root
}->{children
}->{storage
}->{children
}->{$storeid};
1839 foreach my $pool (keys %{$usercfg->{pools
}}) {
1840 delete $usercfg->{pools
}->{$pool}->{storage
}->{$storeid};
1843 cfs_write_file
("user.cfg", $usercfg) if $modified;
1846 lock_user_config
($deleteStorageAccessFn,
1847 "access permissions cleanup for storage $storeid failed");
1850 sub add_vm_to_pool
{
1851 my ($vmid, $pool) = @_;
1853 my $addVMtoPoolFn = sub {
1854 my $usercfg = cfs_read_file
("user.cfg");
1855 if (my $data = $usercfg->{pools
}->{$pool}) {
1856 $data->{vms
}->{$vmid} = 1;
1857 $usercfg->{vms
}->{$vmid} = $pool;
1858 cfs_write_file
("user.cfg", $usercfg);
1862 lock_user_config
($addVMtoPoolFn, "can't add VM $vmid to pool '$pool'");
1865 sub remove_vm_from_pool
{
1868 my $delVMfromPoolFn = sub {
1869 my $usercfg = cfs_read_file
("user.cfg");
1870 if (my $pool = $usercfg->{vms
}->{$vmid}) {
1871 if (my $data = $usercfg->{pools
}->{$pool}) {
1872 delete $data->{vms
}->{$vmid};
1873 delete $usercfg->{vms
}->{$vmid};
1874 cfs_write_file
("user.cfg", $usercfg);
1879 lock_user_config
($delVMfromPoolFn, "pool cleanup for VM $vmid failed");
1882 my $USER_CONTROLLED_TFA_TYPES = {
1887 sub assert_new_tfa_config_available
() {
1888 PVE
::Cluster
::cfs_update
();
1889 my $version_info = PVE
::Cluster
::get_node_kv
('version-info');
1890 die "cannot update tfa config, please make sure all cluster nodes are up to date\n"
1892 my $members = PVE
::Cluster
::get_members
() or return; # get_members returns undef on no cluster
1894 foreach my $node (keys $members->%*) {
1895 my $info = $version_info->{$node};
1897 $old .= " cluster node '$node' is too old, did not broadcast its version info\n";
1900 $info = from_json
($info);
1901 my $ver = $info->{version
};
1902 if ($ver !~ /^(\d+\.\d+)-(\d+)/) {
1903 $old .= " cluster node '$node' provided an invalid version string: '$ver'\n";
1906 my ($maj, $rel) = ($1, $2);
1907 if (!($maj > 7.0 || ($maj == 7.0 && $rel >= 15))) {
1908 $old .= " cluster node '$node' is too old ($ver < 7.0-15)\n";
1912 die "cannot update tfa config, following nodes are not up to date:\n$old" if length($old);
1915 sub user_remove_tfa
: prototype($) {
1918 assert_new_tfa_config_available
();
1920 my $tfa_cfg = cfs_read_file
('priv/tfa.cfg');
1921 $tfa_cfg->remove_user($userid);
1922 cfs_write_file
('priv/tfa.cfg', $tfa_cfg);
1925 my sub add_old_yubico_keys
: prototype($$$) {
1926 my ($userid, $tfa_cfg, $keys) = @_;
1929 foreach my $key (split_list
($keys)) {
1930 my $description = "<old userconfig key $count>";
1932 $tfa_cfg->add_yubico_entry($userid, $description, $key);
1936 my sub normalize_totp_secret
: prototype($) {
1940 # See PVE::OTP::oath_verify_otp:
1941 if ($key =~ /^v2-0x([0-9a-fA-F]+)$/) {
1943 $binkey = pack('H*', $1);
1944 } elsif ($key =~ /^v2-([A-Z2-7=]+)$/) {
1946 $binkey = MIME
::Base32
::decode_rfc3548
($1);
1947 } elsif ($key =~ /^[A-Z2-7=]{16}$/) {
1948 $binkey = MIME
::Base32
::decode_rfc3548
($key);
1949 } elsif ($key =~ /^[A-Fa-f0-9]{40}$/) {
1950 $binkey = pack('H*', $key);
1955 return MIME
::Base32
::encode_rfc3548
($binkey);
1958 my sub add_old_totp_keys
: prototype($$$$) {
1959 my ($userid, $tfa_cfg, $realm_tfa, $keys) = @_;
1961 my $issuer = 'Proxmox%20VE';
1962 my $account = uri_escape
("Old key for $userid");
1963 my $digits = $realm_tfa->{digits
} || 6;
1964 my $step = $realm_tfa->{step
} || 30;
1965 my $uri = "otpauth://totp/$issuer:$account?digits=$digits&period=$step&algorithm=SHA1&secret=";
1968 foreach my $key (split_list
($keys)) {
1969 $key = normalize_totp_secret
($key);
1970 # and just skip invalid keys:
1971 next if !defined($key);
1973 my $description = "<old userconfig key $count>";
1975 eval { $tfa_cfg->add_totp_entry($userid, $description, $uri . $key) };
1980 sub add_old_keys_to_realm_tfa
: prototype($$$$) {
1981 my ($userid, $tfa_cfg, $realm_tfa, $keys) = @_;
1983 # if there's no realm tfa configured, we don't know what the keys mean, so we just ignore
1985 return if !$realm_tfa;
1987 my $type = $realm_tfa->{type
};
1988 if ($type eq 'oath') {
1989 add_old_totp_keys
($userid, $tfa_cfg, $realm_tfa, $keys);
1990 } elsif ($type eq 'yubico') {
1991 add_old_yubico_keys
($userid, $tfa_cfg, $keys);
1993 # invalid keys, we'll just drop them now...
1997 sub user_get_tfa
: prototype($$$) {
1998 my ($username, $realm) = @_;
2000 my $user_cfg = cfs_read_file
('user.cfg');
2001 my $user = $user_cfg->{users
}->{$username}
2002 or die "user '$username' not found\n";
2004 my $keys = $user->{keys};
2006 my $domain_cfg = cfs_read_file
('domains.cfg');
2007 my $realm_cfg = $domain_cfg->{ids
}->{$realm};
2008 die "auth domain '$realm' does not exist\n" if !$realm_cfg;
2010 my $realm_tfa = $realm_cfg->{tfa
};
2011 $realm_tfa = PVE
::Auth
::Plugin
::parse_tfa_config
($realm_tfa)
2015 return if !$realm_tfa;
2016 die "missing required 2nd keys\n";
2019 my $tfa_cfg = cfs_read_file
('priv/tfa.cfg');
2020 if (defined($keys) && $keys !~ /^x(?:!.*)$/) {
2021 add_old_keys_to_realm_tfa
($username, $tfa_cfg, $realm_tfa, $keys);
2023 return ($tfa_cfg, $realm_tfa);
2026 # bash completion helpers
2028 register_standard_option
('userid-completed',
2029 get_standard_option
('userid', { completion
=> \
&complete_username
}),
2032 sub complete_username
{
2034 my $user_cfg = cfs_read_file
('user.cfg');
2036 return [ keys %{$user_cfg->{users
}} ];
2039 sub complete_group
{
2041 my $user_cfg = cfs_read_file
('user.cfg');
2043 return [ keys %{$user_cfg->{groups
}} ];
2046 sub complete_realm
{
2048 my $domain_cfg = cfs_read_file
('domains.cfg');
2050 return [ keys %{$domain_cfg->{ids
}} ];