1 package PVE
::AccessControl
;
6 use Crypt
::OpenSSL
::Random
;
7 use Crypt
::OpenSSL
::RSA
;
18 use PVE
::Tools
qw(run_command lock_file file_get_contents split_list safe_print);
19 use PVE
::Cluster
qw(cfs_register_file cfs_read_file cfs_write_file cfs_lock_file);
20 use PVE
::JSONSchema
qw(register_standard_option get_standard_option);
22 use PVE
::Auth
::Plugin
;
28 # load and initialize all plugins
30 PVE
::Auth
::AD-
>register();
31 PVE
::Auth
::LDAP-
>register();
32 PVE
::Auth
::PVE-
>register();
33 PVE
::Auth
::PAM-
>register();
34 PVE
::Auth
::Plugin-
>init();
36 # $authdir must be writable by root only!
37 my $confdir = "/etc/pve";
38 my $authdir = "$confdir/priv";
40 my $pve_www_key_fn = "$confdir/pve-www.key";
42 my $pve_auth_key_files = {
43 priv
=> "$authdir/authkey.key",
44 pub
=> "$confdir/authkey.pub",
45 pubold
=> "$confdir/authkey.pub.old",
48 my $pve_auth_key_cache = {};
50 my $ticket_lifetime = 3600 * 2; # 2 hours
51 my $auth_graceperiod = 60 * 5; # 5 minutes
52 my $authkey_lifetime = 3600 * 24; # rotate every 24 hours
54 Crypt
::OpenSSL
::RSA-
>import_random_seed();
56 cfs_register_file
('user.cfg',
59 cfs_register_file
('priv/tfa.cfg',
60 \
&parse_priv_tfa_config
,
61 \
&write_priv_tfa_config
);
64 PVE
::Auth
::Plugin
::verify_username
(@_);
67 sub pve_verify_realm
{
68 PVE
::Auth
::Plugin
::pve_verify_realm
(@_);
71 sub lock_user_config
{
72 my ($code, $errmsg) = @_;
74 cfs_lock_file
("user.cfg", undef, $code);
76 $errmsg ?
die "$errmsg: $err" : die $err;
80 my $cache_read_key = sub {
83 my $path = $pve_auth_key_files->{$type};
85 my $read_key_and_mtime = sub {
86 my $fh = IO
::File-
>new($path, "r");
88 return undef if !defined($fh);
91 my $pem = PVE
::Tools
::safe_read_from
($fh, 0, 0, $path);
96 if ($type eq 'pub' || $type eq 'pubold') {
97 $key = eval { Crypt
::OpenSSL
::RSA-
>new_public_key($pem); };
98 } elsif ($type eq 'priv') {
99 $key = eval { Crypt
::OpenSSL
::RSA-
>new_private_key($pem); };
101 die "Invalid authkey type '$type'\n";
104 return { key
=> $key, mtime
=> $st->mtime };
107 if (!defined($pve_auth_key_cache->{$type})) {
108 $pve_auth_key_cache->{$type} = $read_key_and_mtime->();
110 my $st = stat($path);
111 if (!$st || $st->mtime != $pve_auth_key_cache->{$type}->{mtime
}) {
112 $pve_auth_key_cache->{$type} = $read_key_and_mtime->();
116 return $pve_auth_key_cache->{$type};
122 my $type = $old ?
'pubold' : 'pub';
124 my $res = $cache_read_key->($type);
125 return undef if !defined($res);
127 return wantarray ?
($res->{key
}, $res->{mtime
}) : $res->{key
};
131 my $res = $cache_read_key->('priv');
133 if (!defined($res) || !check_authkey
(1)) {
135 $res = $cache_read_key->('priv');
138 return wantarray ?
($res->{key
}, $res->{mtime
}) : $res->{key
};
144 # skip check if non-quorate, as rotation is not possible anyway
145 return 1 if !PVE
::Cluster
::check_cfs_quorum
(1);
147 my ($pub_key, $mtime) = get_pubkey
();
149 warn "auth key pair missing, generating new one..\n" if !$quiet;
153 if ($now - $mtime >= $authkey_lifetime) {
154 warn "auth key pair too old, rotating..\n" if !$quiet;;
156 } elsif ($mtime > $now + $auth_graceperiod) {
157 # a nodes RTC had a time set in the future during key generation -> ticket
158 # validity is clamped to 0+5 min grace period until now >= mtime again
159 my (undef, $old_mtime) = get_pubkey
(1);
160 if ($old_mtime && $mtime >= $old_mtime && $mtime - $old_mtime < $ticket_lifetime) {
161 warn "auth key pair generated in the future (key $mtime > host $now),"
162 ." but old key still exists and in valid grace period so avoid automatic"
163 ." fixup. Cluster time not in sync?\n" if !$quiet;
166 warn "auth key pair generated in the future (key $mtime > host $now), rotating..\n" if !$quiet;
169 warn "auth key new enough, skipping rotation\n" if !$quiet;;
176 return if $authkey_lifetime == 0;
178 PVE
::Cluster
::cfs_lock_authkey
(undef, sub {
179 # re-check with lock to avoid double rotation in clusters
180 return if check_authkey
();
182 my $old = get_pubkey
();
183 my $new = Crypt
::OpenSSL
::RSA-
>generate_key(2048);
187 my $pem = $old->get_public_key_x509_string();
188 # mtime is used for caching and ticket age range calculation
189 PVE
::Tools
::file_set_contents
($pve_auth_key_files->{pubold
}, $pem);
191 die "Failed to store old auth key: $@\n" if $@;
195 my $pem = $new->get_public_key_x509_string();
196 # mtime is used for caching and ticket age range calculation,
197 # should be close to that of pubold above
198 PVE
::Tools
::file_set_contents
($pve_auth_key_files->{pub
}, $pem);
202 warn "Failed to store new auth key - $@\n";
203 warn "Reverting to previous auth key\n";
205 my $pem = $old->get_public_key_x509_string();
206 PVE
::Tools
::file_set_contents
($pve_auth_key_files->{pub
}, $pem);
208 die "Failed to restore old auth key: $@\n" if $@;
210 die "Failed to store new auth key - $@\n";
215 my $pem = $new->get_private_key_string();
216 PVE
::Tools
::file_set_contents
($pve_auth_key_files->{priv
}, $pem);
219 warn "Failed to store new auth key - $@\n";
220 warn "Deleting auth key to force regeneration\n";
221 unlink $pve_auth_key_files->{pub
};
222 unlink $pve_auth_key_files->{priv
};
228 PVE
::JSONSchema
::register_standard_option
('tokenid', {
229 description
=> "API token identifier.",
231 format
=> "pve-tokenid",
234 our $token_subid_regex = $PVE::Auth
::Plugin
::realm_regex
;
236 # username@realm username realm tokenid
237 our $token_full_regex = qr/((${PVE::Auth::Plugin::user_regex})\@(${PVE::Auth::Plugin::realm_regex}))!(${token_subid_regex})/;
239 our $userid_or_token_regex = qr/^$PVE::Auth::Plugin::user_regex\@$PVE::Auth::Plugin::realm_regex(?:!$token_subid_regex)?$/;
242 my ($tokenid, $noerr) = @_;
244 if ($tokenid =~ /^${token_full_regex}$/) {
248 die "'$tokenid' is not a valid token ID - not able to split into user and token parts\n" if !$noerr;
254 my ($username, $tokensubid) = @_;
256 my $joined = "${username}!${tokensubid}";
258 return pve_verify_tokenid
($joined);
261 PVE
::JSONSchema
::register_format
('pve-tokenid', \
&pve_verify_tokenid
);
262 sub pve_verify_tokenid
{
263 my ($tokenid, $noerr) = @_;
265 if ($tokenid =~ /^${token_full_regex}$/) {
266 return wantarray ?
($tokenid, $2, $3, $4) : $tokenid;
269 die "value '$tokenid' does not look like a valid token ID\n" if !$noerr;
275 my $csrf_prevention_secret;
276 my $csrf_prevention_secret_legacy;
277 my $get_csrfr_secret = sub {
278 if (!$csrf_prevention_secret) {
279 my $input = PVE
::Tools
::file_get_contents
($pve_www_key_fn);
280 $csrf_prevention_secret = Digest
::SHA
::hmac_sha256_base64
($input);
281 $csrf_prevention_secret_legacy = Digest
::SHA
::sha1_base64
($input);
283 return $csrf_prevention_secret;
286 sub assemble_csrf_prevention_token
{
289 my $secret = &$get_csrfr_secret();
291 return PVE
::Ticket
::assemble_csrf_prevention_token
($secret, $username);
294 sub verify_csrf_prevention_token
{
295 my ($username, $token, $noerr) = @_;
297 my $secret = $get_csrfr_secret->();
299 # FIXME: remove with PVE 7 and/or refactor all into PVE::Ticket ?
300 if ($token =~ m/^([A-Z0-9]{8}):(\S+)$/) {
302 if (length($sig) == 27) {
303 # the legacy secret got populated by above get_csrfr_secret call
304 $secret = $csrf_prevention_secret_legacy;
308 return PVE
::Ticket
::verify_csrf_prevention_token
(
309 $secret, $username, $token, -$auth_graceperiod, $ticket_lifetime, $noerr);
312 my $get_ticket_age_range = sub {
313 my ($now, $mtime, $rotated) = @_;
315 my $key_age = $now - $mtime;
316 $key_age = 0 if $key_age < 0;
318 my $min = -$auth_graceperiod;
319 my $max = $ticket_lifetime;
322 # ticket creation after rotation is not allowed
323 $min = $key_age - $auth_graceperiod;
325 if ($key_age > $authkey_lifetime && $authkey_lifetime > 0) {
326 if (PVE
::Cluster
::check_cfs_quorum
(1)) {
327 # key should have been rotated, clamp range accordingly
328 $min = $key_age - $authkey_lifetime;
330 warn "Cluster not quorate - extending auth key lifetime!\n";
334 $max = $key_age + $auth_graceperiod if $key_age < $ticket_lifetime;
337 return undef if $min > $ticket_lifetime;
341 sub assemble_ticket
{
344 my $rsa_priv = get_privkey
();
346 return PVE
::Ticket
::assemble_rsa_ticket
($rsa_priv, 'PVE', $data);
350 my ($ticket, $noerr) = @_;
357 my ($rsa_pub, $rsa_mtime) = get_pubkey
($old);
358 return undef if !$rsa_pub;
360 my ($min, $max) = $get_ticket_age_range->($now, $rsa_mtime, $old);
361 return undef if !defined($min);
363 return PVE
::Ticket
::verify_rsa_ticket
(
364 $rsa_pub, 'PVE', $ticket, undef, $min, $max, 1);
367 my ($data, $age) = $check->();
369 # check with old, rotated key if current key failed
370 ($data, $age) = $check->(1) if !defined($data);
372 my $auth_failure = sub {
376 # raise error via undef ticket
377 PVE
::Ticket
::verify_rsa_ticket
(undef, 'PVE');
381 if (!defined($data)) {
382 return $auth_failure->();
385 my ($username, $tfa_info);
386 if ($data =~ m{^u2f!([^!]+)!([0-9a-zA-Z/.=_\-+]+)$}) {
387 # Ticket for u2f-users:
388 ($username, my $challenge) = ($1, $2);
389 if ($challenge eq 'verified') {
390 # u2f challenge was completed
392 } elsif (!wantarray) {
393 # The caller is not aware there could be an ongoing challenge,
394 # so we treat this ticket as invalid:
395 return $auth_failure->();
399 challenge
=> $challenge,
401 } elsif ($data =~ /^tfa!(.*)$/) {
402 # TOTP and Yubico don't require a challenge so this is the generic
403 # 'missing 2nd factor ticket'
405 $tfa_info = { type
=> 'tfa' };
407 # Regular ticket (full access)
411 return undef if !PVE
::Auth
::Plugin
::verify_username
($username, $noerr);
413 return wantarray ?
($username, $age, $tfa_info) : $username;
417 my ($api_token) = @_;
419 die "no API token specified\n" if !$api_token;
421 my ($tokenid, $value);
422 if ($api_token =~ /^(.*)=(.*)$/) {
426 die "no tokenid specified\n";
429 my ($username, $token) = split_tokenid
($tokenid);
431 my $usercfg = cfs_read_file
('user.cfg');
432 check_user_enabled
($usercfg, $username);
433 check_token_exist
($usercfg, $username, $token);
437 my $user = $usercfg->{users
}->{$username};
438 die "account expired\n" if $user->{expire
} && ($user->{expire
} < $ctime);
440 my $token_info = $user->{tokens
}->{$token};
441 die "token expired\n" if $token_info->{expire
} && ($token_info->{expire
} < $ctime);
443 die "invalid token value!\n" if !PVE
::Cluster
::verify_token
($tokenid, $value);
445 return wantarray ?
($tokenid) : $tokenid;
450 # - they do not contain the username in plain text
451 # - they are restricted to a specific resource path (example: '/vms/100')
452 sub assemble_vnc_ticket
{
453 my ($username, $path) = @_;
455 my $rsa_priv = get_privkey
();
457 $path = normalize_path
($path);
459 my $secret_data = "$username:$path";
461 return PVE
::Ticket
::assemble_rsa_ticket
(
462 $rsa_priv, 'PVEVNC', undef, $secret_data);
465 sub verify_vnc_ticket
{
466 my ($ticket, $username, $path, $noerr) = @_;
468 my $secret_data = "$username:$path";
470 my ($rsa_pub, $rsa_mtime) = get_pubkey
();
471 if (!$rsa_pub || (time() - $rsa_mtime > $authkey_lifetime && $authkey_lifetime > 0)) {
475 # raise error via undef ticket
476 PVE
::Ticket
::verify_rsa_ticket
($rsa_pub, 'PVEVNC');
480 return PVE
::Ticket
::verify_rsa_ticket
(
481 $rsa_pub, 'PVEVNC', $ticket, $secret_data, -20, 40, $noerr);
484 sub assemble_spice_ticket
{
485 my ($username, $vmid, $node) = @_;
487 my $secret = &$get_csrfr_secret();
489 return PVE
::Ticket
::assemble_spice_ticket
(
490 $secret, $username, $vmid, $node);
493 sub verify_spice_connect_url
{
494 my ($connect_str) = @_;
496 my $secret = &$get_csrfr_secret();
498 return PVE
::Ticket
::verify_spice_connect_url
($secret, $connect_str);
501 sub read_x509_subject_spice
{
505 my $bio = Net
::SSLeay
::BIO_new_file
($filename, 'r');
506 die "Could not open $filename using OpenSSL\n"
509 my $x509 = Net
::SSLeay
::PEM_read_bio_X509
($bio);
510 Net
::SSLeay
::BIO_free
($bio);
512 die "Could not parse X509 certificate in $filename\n"
515 my $nameobj = Net
::SSLeay
::X509_get_subject_name
($x509);
516 my $subject = Net
::SSLeay
::X509_NAME_oneline
($nameobj);
517 Net
::SSLeay
::X509_free
($x509);
519 # remote-viewer wants comma as seperator (not '/')
521 $subject =~ s!/(\w+=)!,$1!g;
526 # helper to generate SPICE remote-viewer configuration
527 sub remote_viewer_config
{
528 my ($authuser, $vmid, $node, $proxy, $title, $port) = @_;
531 my $host = `hostname -f` || PVE
::INotify
::nodename
();
536 my ($ticket, $proxyticket) = assemble_spice_ticket
($authuser, $vmid, $node);
538 my $filename = "/etc/pve/local/pve-ssl.pem";
539 my $subject = read_x509_subject_spice
($filename);
541 my $cacert = PVE
::Tools
::file_get_contents
("/etc/pve/pve-root-ca.pem", 8192);
542 $cacert =~ s/\n/\\n/g;
544 $proxy = "[$proxy]" if Net
::IP
::ip_is_ipv6
($proxy);
546 'secure-attention' => "Ctrl+Alt+Ins",
547 'toggle-fullscreen' => "Shift+F11",
548 'release-cursor' => "Ctrl+Alt+R",
551 host
=> $proxyticket, # this breaks tls hostname verification, so we need to use 'host-subject'
552 proxy
=> "http://$proxy:3128",
554 'host-subject' => $subject,
557 'delete-this-file' => 1,
560 return ($ticket, $proxyticket, $config);
563 sub check_user_exist
{
564 my ($usercfg, $username, $noerr) = @_;
566 $username = PVE
::Auth
::Plugin
::verify_username
($username, $noerr);
567 return undef if !$username;
569 return $usercfg->{users
}->{$username} if $usercfg && $usercfg->{users
}->{$username};
571 die "no such user ('$username')\n" if !$noerr;
576 sub check_user_enabled
{
577 my ($usercfg, $username, $noerr) = @_;
579 my $data = check_user_exist
($usercfg, $username, $noerr);
580 return undef if !$data;
582 return 1 if $data->{enable
};
584 die "user '$username' is disabled\n" if !$noerr;
589 sub check_token_exist
{
590 my ($usercfg, $username, $tokenid, $noerr) = @_;
592 my $user = check_user_exist
($usercfg, $username, $noerr);
593 return undef if !$user;
595 return $user->{tokens
}->{$tokenid}
596 if defined($user->{tokens
}) && $user->{tokens
}->{$tokenid};
598 die "no such token '$tokenid' for user '$username'\n" if !$noerr;
603 sub verify_one_time_pw
{
604 my ($type, $username, $keys, $tfa_cfg, $otp) = @_;
606 die "missing one time password for two-factor authentication '$type'\n" if !$otp;
608 # fixme: proxy support?
611 if ($type eq 'yubico') {
612 PVE
::OTP
::yubico_verify_otp
($otp, $keys, $tfa_cfg->{url
},
613 $tfa_cfg->{id
}, $tfa_cfg->{key
}, $proxy);
614 } elsif ($type eq 'oath') {
615 PVE
::OTP
::oath_verify_otp
($otp, $keys, $tfa_cfg->{step
}, $tfa_cfg->{digits
});
617 die "unknown tfa type '$type'\n";
621 # password should be utf8 encoded
622 # Note: some plugins delay/sleep if auth fails
623 sub authenticate_user
{
624 my ($username, $password, $otp) = @_;
626 die "no username specified\n" if !$username;
630 ($username, $ruid, $realm) = PVE
::Auth
::Plugin
::verify_username
($username);
632 my $usercfg = cfs_read_file
('user.cfg');
634 check_user_enabled
($usercfg, $username);
637 my $expire = $usercfg->{users
}->{$username}->{expire
};
639 die "account expired\n" if $expire && ($expire < $ctime);
641 my $domain_cfg = cfs_read_file
('domains.cfg');
643 my $cfg = $domain_cfg->{ids
}->{$realm};
644 die "auth domain '$realm' does not exist\n" if !$cfg;
645 my $plugin = PVE
::Auth
::Plugin-
>lookup($cfg->{type
});
646 $plugin->authenticate_user($cfg, $realm, $ruid, $password);
648 my ($type, $tfa_data) = user_get_tfa
($username, $realm);
650 if ($type eq 'u2f') {
651 # Note that if the user did not manage to complete the initial u2f registration
652 # challenge we have a hash containing a 'challenge' entry in the user's tfa.cfg entry:
653 $tfa_data = undef if exists $tfa_data->{challenge
};
654 } elsif (!defined($otp)) {
655 # The user requires a 2nd factor but has not provided one. Return success but
656 # don't clear $tfa_data.
658 my $keys = $tfa_data->{keys};
659 my $tfa_cfg = $tfa_data->{config
};
660 verify_one_time_pw
($type, $username, $keys, $tfa_cfg, $otp);
664 # Return the type along with the rest:
673 return wantarray ?
($username, $tfa_data) : $username;
676 sub domain_set_password
{
677 my ($realm, $username, $password) = @_;
679 die "no auth domain specified" if !$realm;
681 my $domain_cfg = cfs_read_file
('domains.cfg');
683 my $cfg = $domain_cfg->{ids
}->{$realm};
684 die "auth domain '$realm' does not exist\n" if !$cfg;
685 my $plugin = PVE
::Auth
::Plugin-
>lookup($cfg->{type
});
686 $plugin->store_password($cfg, $realm, $username, $password);
690 my ($username, $usercfg, $group) = @_;
692 $usercfg->{users
}->{$username}->{groups
}->{$group} = 1;
693 $usercfg->{groups
}->{$group}->{users
}->{$username} = 1;
696 sub delete_user_group
{
697 my ($username, $usercfg) = @_;
699 foreach my $group (keys %{$usercfg->{groups
}}) {
701 delete ($usercfg->{groups
}->{$group}->{users
}->{$username})
702 if $usercfg->{groups
}->{$group}->{users
}->{$username};
706 sub delete_user_acl
{
707 my ($username, $usercfg) = @_;
709 foreach my $acl (keys %{$usercfg->{acl
}}) {
711 delete ($usercfg->{acl
}->{$acl}->{users
}->{$username})
712 if $usercfg->{acl
}->{$acl}->{users
}->{$username};
716 sub delete_group_acl
{
717 my ($group, $usercfg) = @_;
719 foreach my $acl (keys %{$usercfg->{acl
}}) {
721 delete ($usercfg->{acl
}->{$acl}->{groups
}->{$group})
722 if $usercfg->{acl
}->{$acl}->{groups
}->{$group};
726 sub delete_pool_acl
{
727 my ($pool, $usercfg) = @_;
729 my $path = "/pool/$pool";
731 delete ($usercfg->{acl
}->{$path})
734 # we automatically create some predefined roles by splitting privs
735 # into 3 groups (per category)
736 # root: only root is allowed to do that
737 # admin: an administrator can to that
738 # user: a normal user/customer can to that
748 'VM.Config.Options', # covers all other things
754 'VM.Snapshot.Rollback',
757 'VM.Config.CDROM', # change CDROM media
758 'VM.Config.Cloudinit',
770 'Sys.Modify', # edit/change node settings
773 'Permissions.Modify',
785 'Datastore.Allocate',
786 'Datastore.AllocateTemplate',
789 'Datastore.AllocateSpace',
811 'Group.Allocate', # edit/change group settings
812 'Realm.AllocateUser',
820 'Pool.Allocate', # create/delete pools
827 my $valid_privs = {};
829 my $special_roles = {
830 'NoAccess' => {}, # no privileges
831 'Administrator' => $valid_privs, # all privileges
836 foreach my $cat (keys %$privgroups) {
837 my $cd = $privgroups->{$cat};
838 foreach my $p (@{$cd->{root
}}, @{$cd->{admin
}},
839 @{$cd->{user
}}, @{$cd->{audit
}}) {
840 $valid_privs->{$p} = 1;
842 foreach my $p (@{$cd->{admin
}}, @{$cd->{user
}}, @{$cd->{audit
}}) {
844 $special_roles->{"PVE${cat}Admin"}->{$p} = 1;
845 $special_roles->{"PVEAdmin"}->{$p} = 1;
847 if (scalar(@{$cd->{user
}})) {
848 foreach my $p (@{$cd->{user
}}, @{$cd->{audit
}}) {
849 $special_roles->{"PVE${cat}User"}->{$p} = 1;
852 foreach my $p (@{$cd->{audit
}}) {
853 $special_roles->{"PVEAuditor"}->{$p} = 1;
857 $special_roles->{"PVETemplateUser"} = { 'VM.Clone' => 1, 'VM.Audit' => 1 };
862 sub create_priv_properties
{
864 foreach my $priv (keys %$valid_privs) {
865 $properties->{$priv} = {
873 sub role_is_special
{
875 return (exists $special_roles->{$role}) ?
1 : 0;
879 my ($role, $usercfg, $privs) = @_;
883 die "role '$role' does not exist\n" if !$usercfg->{roles
}->{$role};
885 foreach my $priv (split_list
($privs)) {
886 if (defined ($valid_privs->{$priv})) {
887 $usercfg->{roles
}->{$role}->{$priv} = 1;
889 die "invalid privilege '$priv'\n";
894 sub lookup_username
{
895 my ($username, $noerr) = @_;
897 $username =~ m!^(${PVE::Auth::Plugin::user_regex})\@(${PVE::Auth::Plugin::realm_regex})$!;
900 my $domain_cfg = cfs_read_file
("domains.cfg");
901 my $casesensitive = $domain_cfg->{ids
}->{$realm}->{'case-sensitive'} // 1;
902 my $usercfg = cfs_read_file
('user.cfg');
904 if (!$casesensitive) {
905 my @matches = grep { lc $username eq lc $_ } (keys %{$usercfg->{users
}});
907 die "ambiguous case insensitive match of username '$username', cannot safely grant access!\n"
908 if scalar @matches > 1 && !$noerr;
923 $path = '/' if !$path;
925 $path = "/$path" if $path !~ m
|^/|;
927 return undef if $path !~ m
|^[[:alnum
:]\
.\
-\_\
/]+$|;
932 PVE
::JSONSchema
::register_format
('pve-groupid', \
&verify_groupname
);
933 sub verify_groupname
{
934 my ($groupname, $noerr) = @_;
936 if ($groupname !~ m/^[A-Za-z0-9\.\-_]+$/) {
938 die "group name '$groupname' contains invalid characters\n" if !$noerr;
946 PVE
::JSONSchema
::register_format
('pve-roleid', \
&verify_rolename
);
947 sub verify_rolename
{
948 my ($rolename, $noerr) = @_;
950 if ($rolename !~ m/^[A-Za-z0-9\.\-_]+$/) {
952 die "role name '$rolename' contains invalid characters\n" if !$noerr;
960 PVE
::JSONSchema
::register_format
('pve-poolid', \
&verify_poolname
);
961 sub verify_poolname
{
962 my ($poolname, $noerr) = @_;
964 if ($poolname !~ m/^[A-Za-z0-9\.\-_]+$/) {
966 die "pool name '$poolname' contains invalid characters\n" if !$noerr;
974 PVE
::JSONSchema
::register_format
('pve-priv', \
&verify_privname
);
975 sub verify_privname
{
976 my ($priv, $noerr) = @_;
978 if (!$valid_privs->{$priv}) {
979 die "invalid privilege '$priv'\n" if !$noerr;
987 sub userconfig_force_defaults
{
990 foreach my $r (keys %$special_roles) {
991 $cfg->{roles
}->{$r} = $special_roles->{$r};
994 # add root user if not exists
995 if (!$cfg->{users
}->{'root@pam'}) {
996 $cfg->{users
}->{'root@pam'}->{enable
} = 1;
1000 sub parse_user_config
{
1001 my ($filename, $raw) = @_;
1005 userconfig_force_defaults
($cfg);
1007 $raw = '' if !defined($raw);
1008 while ($raw =~ /^\s*(.+?)\s*$/gm) {
1012 foreach my $d (split (/:/, $line)) {
1018 my $et = shift @data;
1020 if ($et eq 'user') {
1021 my ($user, $enable, $expire, $firstname, $lastname, $email, $comment, $keys) = @data;
1023 my (undef, undef, $realm) = PVE
::Auth
::Plugin
::verify_username
($user, 1);
1025 warn "user config - ignore user '$user' - invalid user name\n";
1029 $enable = $enable ?
1 : 0;
1031 $expire = 0 if !$expire;
1033 if ($expire !~ m/^\d+$/) {
1034 warn "user config - ignore user '$user' - (illegal characters in expire '$expire')\n";
1037 $expire = int($expire);
1039 #if (!verify_groupname ($group, 1)) {
1040 # warn "user config - ignore user '$user' - invalid characters in group name\n";
1044 $cfg->{users
}->{$user} = {
1048 $cfg->{users
}->{$user}->{firstname
} = PVE
::Tools
::decode_text
($firstname) if $firstname;
1049 $cfg->{users
}->{$user}->{lastname
} = PVE
::Tools
::decode_text
($lastname) if $lastname;
1050 $cfg->{users
}->{$user}->{email
} = $email;
1051 $cfg->{users
}->{$user}->{comment
} = PVE
::Tools
::decode_text
($comment) if $comment;
1052 $cfg->{users
}->{$user}->{expire
} = $expire;
1053 # keys: allowed yubico key ids or oath secrets (base32 encoded)
1054 $cfg->{users
}->{$user}->{keys} = $keys if $keys;
1056 #$cfg->{users}->{$user}->{groups}->{$group} = 1;
1057 #$cfg->{groups}->{$group}->{$user} = 1;
1059 } elsif ($et eq 'group') {
1060 my ($group, $userlist, $comment) = @data;
1062 if (!verify_groupname
($group, 1)) {
1063 warn "user config - ignore group '$group' - invalid characters in group name\n";
1067 # make sure to add the group (even if there are no members)
1068 $cfg->{groups
}->{$group} = { users
=> {} } if !$cfg->{groups
}->{$group};
1070 $cfg->{groups
}->{$group}->{comment
} = PVE
::Tools
::decode_text
($comment) if $comment;
1072 foreach my $user (split_list
($userlist)) {
1074 if (!PVE
::Auth
::Plugin
::verify_username
($user, 1)) {
1075 warn "user config - ignore invalid group member '$user'\n";
1079 if ($cfg->{users
}->{$user}) { # user exists
1080 $cfg->{users
}->{$user}->{groups
}->{$group} = 1;
1082 warn "user config - ignore invalid group member '$user'\n";
1084 $cfg->{groups
}->{$group}->{users
}->{$user} = 1;
1087 } elsif ($et eq 'role') {
1088 my ($role, $privlist) = @data;
1090 if (!verify_rolename
($role, 1)) {
1091 warn "user config - ignore role '$role' - invalid characters in role name\n";
1095 # make sure to add the role (even if there are no privileges)
1096 $cfg->{roles
}->{$role} = {} if !$cfg->{roles
}->{$role};
1098 foreach my $priv (split_list
($privlist)) {
1099 if (defined ($valid_privs->{$priv})) {
1100 $cfg->{roles
}->{$role}->{$priv} = 1;
1102 warn "user config - ignore invalid privilege '$priv'\n";
1106 } elsif ($et eq 'acl') {
1107 my ($propagate, $pathtxt, $uglist, $rolelist) = @data;
1109 $propagate = $propagate ?
1 : 0;
1111 if (my $path = normalize_path
($pathtxt)) {
1112 foreach my $role (split_list
($rolelist)) {
1114 if (!verify_rolename
($role, 1)) {
1115 warn "user config - ignore invalid role name '$role' in acl\n";
1119 if (!$cfg->{roles
}->{$role}) {
1120 warn "user config - ignore invalid acl role '$role'\n";
1124 foreach my $ug (split_list
($uglist)) {
1125 my ($group) = $ug =~ m/^@(\S+)$/;
1127 if ($group && verify_groupname
($group, 1)) {
1128 if (!$cfg->{groups
}->{$group}) { # group does not exist
1129 warn "user config - ignore invalid acl group '$group'\n";
1131 $cfg->{acl
}->{$path}->{groups
}->{$group}->{$role} = $propagate;
1132 } elsif (PVE
::Auth
::Plugin
::verify_username
($ug, 1)) {
1133 if (!$cfg->{users
}->{$ug}) { # user does not exist
1134 warn "user config - ignore invalid acl member '$ug'\n";
1136 $cfg->{acl
}->{$path}->{users
}->{$ug}->{$role} = $propagate;
1137 } elsif (my ($user, $token) = split_tokenid
($ug, 1)) {
1138 if (check_token_exist
($cfg, $user, $token, 1)) {
1139 $cfg->{acl
}->{$path}->{tokens
}->{$ug}->{$role} = $propagate;
1141 warn "user config - ignore invalid acl token '$ug'\n";
1144 warn "user config - invalid user/group '$ug' in acl\n";
1149 warn "user config - ignore invalid path in acl '$pathtxt'\n";
1151 } elsif ($et eq 'pool') {
1152 my ($pool, $comment, $vmlist, $storelist) = @data;
1154 if (!verify_poolname
($pool, 1)) {
1155 warn "user config - ignore pool '$pool' - invalid characters in pool name\n";
1159 # make sure to add the pool (even if there are no members)
1160 $cfg->{pools
}->{$pool} = { vms
=> {}, storage
=> {} } if !$cfg->{pools
}->{$pool};
1162 $cfg->{pools
}->{$pool}->{comment
} = PVE
::Tools
::decode_text
($comment) if $comment;
1164 foreach my $vmid (split_list
($vmlist)) {
1165 if ($vmid !~ m/^\d+$/) {
1166 warn "user config - ignore invalid vmid '$vmid' in pool '$pool'\n";
1171 if ($cfg->{vms
}->{$vmid}) {
1172 warn "user config - ignore duplicate vmid '$vmid' in pool '$pool'\n";
1176 $cfg->{pools
}->{$pool}->{vms
}->{$vmid} = 1;
1178 # record vmid ==> pool relation
1179 $cfg->{vms
}->{$vmid} = $pool;
1182 foreach my $storeid (split_list
($storelist)) {
1183 if ($storeid !~ m/^[a-z][a-z0-9\-\_\.]*[a-z0-9]$/i) {
1184 warn "user config - ignore invalid storage '$storeid' in pool '$pool'\n";
1187 $cfg->{pools
}->{$pool}->{storage
}->{$storeid} = 1;
1189 } elsif ($et eq 'token') {
1190 my ($tokenid, $expire, $privsep, $comment) = @data;
1192 my ($user, $token) = split_tokenid
($tokenid, 1);
1193 if (!($user && $token)) {
1194 warn "user config - ignore invalid tokenid '$tokenid'\n";
1198 $privsep = $privsep ?
1 : 0;
1200 $expire = 0 if !$expire;
1202 if ($expire !~ m/^\d+$/) {
1203 warn "user config - ignore token '$tokenid' - (illegal characters in expire '$expire')\n";
1206 $expire = int($expire);
1208 if (my $user_cfg = $cfg->{users
}->{$user}) { # user exists
1209 $user_cfg->{tokens
}->{$token} = {} if !$user_cfg->{tokens
}->{$token};
1210 my $token_cfg = $user_cfg->{tokens
}->{$token};
1211 $token_cfg->{privsep
} = $privsep;
1212 $token_cfg->{expire
} = $expire;
1213 $token_cfg->{comment
} = PVE
::Tools
::decode_text
($comment) if $comment;
1215 warn "user config - ignore token '$tokenid' - user does not exist\n";
1218 warn "user config - ignore config line: $line\n";
1222 userconfig_force_defaults
($cfg);
1227 sub write_user_config
{
1228 my ($filename, $cfg) = @_;
1232 foreach my $user (sort keys %{$cfg->{users
}}) {
1233 my $d = $cfg->{users
}->{$user};
1234 my $firstname = $d->{firstname
} ? PVE
::Tools
::encode_text
($d->{firstname
}) : '';
1235 my $lastname = $d->{lastname
} ? PVE
::Tools
::encode_text
($d->{lastname
}) : '';
1236 my $email = $d->{email
} || '';
1237 my $comment = $d->{comment
} ? PVE
::Tools
::encode_text
($d->{comment
}) : '';
1238 my $expire = int($d->{expire
} || 0);
1239 my $enable = $d->{enable
} ?
1 : 0;
1240 my $keys = $d->{keys} ?
$d->{keys} : '';
1241 $data .= "user:$user:$enable:$expire:$firstname:$lastname:$email:$comment:$keys:\n";
1243 my $user_tokens = $d->{tokens
};
1244 foreach my $token (sort keys %$user_tokens) {
1245 my $td = $user_tokens->{$token};
1246 my $full_tokenid = join_tokenid
($user, $token);
1247 my $comment = $td->{comment
} ? PVE
::Tools
::encode_text
($td->{comment
}) : '';
1248 my $expire = int($td->{expire
} || 0);
1249 my $privsep = $td->{privsep
} ?
1 : 0;
1250 $data .= "token:$full_tokenid:$expire:$privsep:$comment:\n";
1256 foreach my $group (sort keys %{$cfg->{groups
}}) {
1257 my $d = $cfg->{groups
}->{$group};
1258 my $list = join (',', sort keys %{$d->{users
}});
1259 my $comment = $d->{comment
} ? PVE
::Tools
::encode_text
($d->{comment
}) : '';
1260 $data .= "group:$group:$list:$comment:\n";
1265 foreach my $pool (sort keys %{$cfg->{pools
}}) {
1266 my $d = $cfg->{pools
}->{$pool};
1267 my $vmlist = join (',', sort keys %{$d->{vms
}});
1268 my $storelist = join (',', sort keys %{$d->{storage
}});
1269 my $comment = $d->{comment
} ? PVE
::Tools
::encode_text
($d->{comment
}) : '';
1270 $data .= "pool:$pool:$comment:$vmlist:$storelist:\n";
1275 foreach my $role (sort keys %{$cfg->{roles
}}) {
1276 next if $special_roles->{$role};
1278 my $d = $cfg->{roles
}->{$role};
1279 my $list = join (',', sort keys %$d);
1280 $data .= "role:$role:$list:\n";
1285 my $collect_rolelist_members = sub {
1286 my ($acl_members, $result, $prefix, $exclude) = @_;
1288 foreach my $member (keys %$acl_members) {
1289 next if $exclude && $member eq $exclude;
1293 foreach my $role (sort keys %{$acl_members->{$member}}) {
1294 my $propagate = $acl_members->{$member}->{$role};
1303 $result->{0}->{$l0}->{"${prefix}${member}"} = 1 if $l0;
1304 $result->{1}->{$l1}->{"${prefix}${member}"} = 1 if $l1;
1308 foreach my $path (sort keys %{$cfg->{acl
}}) {
1309 my $d = $cfg->{acl
}->{$path};
1311 my $rolelist_members = {};
1313 $collect_rolelist_members->($d->{'groups'}, $rolelist_members, '@');
1315 # no need to save 'root@pam', it is always 'Administrator'
1316 $collect_rolelist_members->($d->{'users'}, $rolelist_members, '', 'root@pam');
1318 $collect_rolelist_members->($d->{'tokens'}, $rolelist_members, '');
1320 foreach my $propagate (0,1) {
1321 my $filtered = $rolelist_members->{$propagate};
1322 foreach my $rolelist (sort keys %$filtered) {
1323 my $uglist = join (',', sort keys %{$filtered->{$rolelist}});
1324 $data .= "acl:$propagate:$path:$uglist:$rolelist:\n";
1333 # The TFA configuration in priv/tfa.cfg format contains one line per user of
1336 # DATA is a base64 encoded json string and its format depends on the type.
1337 sub parse_priv_tfa_config
{
1338 my ($filename, $raw) = @_;
1341 my $cfg = { users
=> $users };
1343 $raw = '' if !defined($raw);
1344 while ($raw =~ /^\s*(.+?)\s*$/gm) {
1346 my ($user, $type, $data) = split(/:/, $line, 3);
1348 my (undef, undef, $realm) = PVE
::Auth
::Plugin
::verify_username
($user, 1);
1350 warn "user tfa config - ignore user '$user' - invalid user name\n";
1354 $data = decode_json
(decode_base64
($data));
1365 sub write_priv_tfa_config
{
1366 my ($filename, $cfg) = @_;
1370 my $users = $cfg->{users
};
1371 foreach my $user (sort keys %$users) {
1372 my $info = $users->{$user};
1373 next if !%$info; # skip empty entries
1375 $info = {%$info}; # copy to verify contents:
1377 my $type = delete $info->{type
};
1378 my $data = delete $info->{data
};
1380 if (my @keys = keys %$info) {
1381 die "invalid keys in TFA config for user $user: " . join(', ', @keys) . "\n";
1384 $data = encode_base64
(encode_json
($data), '');
1385 $output .= "${user}:${type}:${data}\n";
1392 my ($cfg, $user, $path) = @_;
1394 # NOTE: we do not consider pools here.
1395 # NOTE: for privsep tokens, this does not filter roles by those that the
1396 # corresponding user has.
1397 # Use $rpcenv->permission() for any actual permission checks!
1399 return 'Administrator' if $user eq 'root@pam'; # root can do anything
1401 if (pve_verify_tokenid
($user, 1)) {
1402 my $tokenid = $user;
1403 my ($username, $token) = split_tokenid
($tokenid);
1405 my $token_info = $cfg->{users
}->{$username}->{tokens
}->{$token};
1406 return () if !$token_info;
1408 my $user_roles = roles
($cfg, $username, $path);
1410 # return full user privileges
1411 return $user_roles if !$token_info->{privsep
};
1416 foreach my $p (sort keys %{$cfg->{acl
}}) {
1417 my $final = ($path eq $p);
1419 next if !(($p eq '/') || $final || ($path =~ m
|^$p/|));
1421 my $acl = $cfg->{acl
}->{$p};
1423 #print "CHECKACL $path $p\n";
1424 #print "ACL $path = " . Dumper ($acl);
1425 if (my $ri = $acl->{tokens
}->{$user}) {
1427 foreach my $role (keys %$ri) {
1428 my $propagate = $ri->{$role};
1429 if ($final || $propagate) {
1430 #print "APPLY ROLE $p $user $role\n";
1432 $new->{$role} = $propagate;
1436 $roles = $new; # overwrite previous settings
1441 if (my $ri = $acl->{users
}->{$user}) {
1443 foreach my $role (keys %$ri) {
1444 my $propagate = $ri->{$role};
1445 if ($final || $propagate) {
1446 #print "APPLY ROLE $p $user $role\n";
1448 $new->{$role} = $propagate;
1452 $roles = $new; # overwrite previous settings
1453 next; # user privs always override group privs
1458 foreach my $g (keys %{$acl->{groups
}}) {
1459 next if !$cfg->{groups
}->{$g}->{users
}->{$user};
1460 if (my $ri = $acl->{groups
}->{$g}) {
1461 foreach my $role (keys %$ri) {
1462 my $propagate = $ri->{$role};
1463 if ($final || $propagate) {
1464 #print "APPLY ROLE $p \@$g $role\n";
1466 $new->{$role} = $propagate;
1472 $roles = $new; # overwrite previous settings
1477 return { 'NoAccess' => $roles->{NoAccess
} } if defined ($roles->{NoAccess
});
1478 #return () if defined ($roles->{NoAccess});
1480 #print "permission $user $path = " . Dumper ($roles);
1482 #print "roles $user $path = " . join (',', @ra) . "\n";
1487 sub remove_vm_access
{
1489 my $delVMaccessFn = sub {
1490 my $usercfg = cfs_read_file
("user.cfg");
1493 if (my $acl = $usercfg->{acl
}->{"/vms/$vmid"}) {
1494 delete $usercfg->{acl
}->{"/vms/$vmid"};
1497 if (my $pool = $usercfg->{vms
}->{$vmid}) {
1498 if (my $data = $usercfg->{pools
}->{$pool}) {
1499 delete $data->{vms
}->{$vmid};
1500 delete $usercfg->{vms
}->{$vmid};
1504 cfs_write_file
("user.cfg", $usercfg) if $modified;
1507 lock_user_config
($delVMaccessFn, "access permissions cleanup for VM $vmid failed");
1510 sub remove_storage_access
{
1513 my $deleteStorageAccessFn = sub {
1514 my $usercfg = cfs_read_file
("user.cfg");
1517 if (my $storage = $usercfg->{acl
}->{"/storage/$storeid"}) {
1518 delete $usercfg->{acl
}->{"/storage/$storeid"};
1521 foreach my $pool (keys %{$usercfg->{pools
}}) {
1522 delete $usercfg->{pools
}->{$pool}->{storage
}->{$storeid};
1525 cfs_write_file
("user.cfg", $usercfg) if $modified;
1528 lock_user_config
($deleteStorageAccessFn,
1529 "access permissions cleanup for storage $storeid failed");
1532 sub add_vm_to_pool
{
1533 my ($vmid, $pool) = @_;
1535 my $addVMtoPoolFn = sub {
1536 my $usercfg = cfs_read_file
("user.cfg");
1537 if (my $data = $usercfg->{pools
}->{$pool}) {
1538 $data->{vms
}->{$vmid} = 1;
1539 $usercfg->{vms
}->{$vmid} = $pool;
1540 cfs_write_file
("user.cfg", $usercfg);
1544 lock_user_config
($addVMtoPoolFn, "can't add VM $vmid to pool '$pool'");
1547 sub remove_vm_from_pool
{
1550 my $delVMfromPoolFn = sub {
1551 my $usercfg = cfs_read_file
("user.cfg");
1552 if (my $pool = $usercfg->{vms
}->{$vmid}) {
1553 if (my $data = $usercfg->{pools
}->{$pool}) {
1554 delete $data->{vms
}->{$vmid};
1555 delete $usercfg->{vms
}->{$vmid};
1556 cfs_write_file
("user.cfg", $usercfg);
1561 lock_user_config
($delVMfromPoolFn, "pool cleanup for VM $vmid failed");
1564 my $USER_CONTROLLED_TFA_TYPES = {
1569 # Delete an entry by setting $data=undef in which case $type is ignored.
1570 # Otherwise both must be valid.
1572 my ($userid, $realm, $type, $data, $cached_usercfg, $cached_domaincfg) = @_;
1574 if (defined($data) && !defined($type)) {
1575 # This is an internal usage error and should not happen
1576 die "cannot set tfa data without a type\n";
1579 my $user_cfg = $cached_usercfg || cfs_read_file
('user.cfg');
1580 my $user = $user_cfg->{users
}->{$userid}
1581 or die "user '$userid' not found\n";
1583 my $domain_cfg = $cached_domaincfg || cfs_read_file
('domains.cfg');
1584 my $realm_cfg = $domain_cfg->{ids
}->{$realm};
1585 die "auth domain '$realm' does not exist\n" if !$realm_cfg;
1587 my $realm_tfa = $realm_cfg->{tfa
};
1588 if (defined($realm_tfa)) {
1589 $realm_tfa = PVE
::Auth
::Plugin
::parse_tfa_config
($realm_tfa);
1590 # If the realm has a TFA setting, we're only allowed to use that.
1591 if (defined($data)) {
1592 my $required_type = $realm_tfa->{type
};
1593 if ($required_type ne $type) {
1594 die "realm '$realm' only allows TFA of type '$required_type\n";
1597 if (defined($data->{config
})) {
1598 # XXX: Is it enough if the type matches? Or should the configuration also match?
1601 # realm-configured tfa always uses a simple key list, so use the user.cfg
1602 $user->{keys} = $data->{keys};
1604 die "realm '$realm' does not allow removing the 2nd factor\n";
1607 # Without a realm-enforced TFA setting the user can add a u2f or totp entry by themselves.
1608 # The 'yubico' type requires yubico server settings, which have to be configured on the
1609 # realm, so this is not supported here:
1610 die "domain '$realm' does not support TFA type '$type'\n"
1611 if defined($data) && !$USER_CONTROLLED_TFA_TYPES->{$type};
1614 # Custom TFA entries are stored in priv/tfa.cfg as they can be more complet: u2f uses a
1615 # public key and a key handle, TOTP requires the usual totp settings...
1617 my $tfa_cfg = cfs_read_file
('priv/tfa.cfg');
1618 my $tfa = ($tfa_cfg->{users
}->{$userid} //= {});
1620 if (defined($data)) {
1621 $tfa->{type
} = $type;
1622 $tfa->{data
} = $data;
1623 cfs_write_file
('priv/tfa.cfg', $tfa_cfg);
1625 $user->{keys} = "x!$type";
1627 delete $tfa_cfg->{users
}->{$userid};
1628 cfs_write_file
('priv/tfa.cfg', $tfa_cfg);
1630 delete $user->{keys};
1633 cfs_write_file
('user.cfg', $user_cfg);
1637 my ($username, $realm) = @_;
1639 my $user_cfg = cfs_read_file
('user.cfg');
1640 my $user = $user_cfg->{users
}->{$username}
1641 or die "user '$username' not found\n";
1643 my $keys = $user->{keys};
1645 my $domain_cfg = cfs_read_file
('domains.cfg');
1646 my $realm_cfg = $domain_cfg->{ids
}->{$realm};
1647 die "auth domain '$realm' does not exist\n" if !$realm_cfg;
1649 my $realm_tfa = $realm_cfg->{tfa
};
1650 $realm_tfa = PVE
::Auth
::Plugin
::parse_tfa_config
($realm_tfa)
1654 return if !$realm_tfa;
1655 die "missing required 2nd keys\n";
1658 # new style config starts with an 'x' and optionally contains a !<type> suffix
1659 if ($keys !~ /^x(?:!.*)?$/) {
1660 # old style config, find the type via the realm
1661 return if !$realm_tfa;
1662 return ($realm_tfa->{type
}, {
1664 config
=> $realm_tfa,
1667 my $tfa_cfg = cfs_read_file
('priv/tfa.cfg');
1668 my $tfa = $tfa_cfg->{users
}->{$username};
1669 return if !$tfa; # should not happen (user.cfg wasn't cleaned up?)
1672 # if the realm has a tfa setting we need to verify the type:
1673 die "auth domain '$realm' and user have mismatching TFA settings\n"
1674 if $realm_tfa && $realm_tfa->{type
} ne $tfa->{type
};
1677 return ($tfa->{type
}, $tfa->{data
});
1681 # bash completion helpers
1683 register_standard_option
('userid-completed',
1684 get_standard_option
('userid', { completion
=> \
&complete_username
}),
1687 sub complete_username
{
1689 my $user_cfg = cfs_read_file
('user.cfg');
1691 return [ keys %{$user_cfg->{users
}} ];
1694 sub complete_group
{
1696 my $user_cfg = cfs_read_file
('user.cfg');
1698 return [ keys %{$user_cfg->{groups
}} ];
1701 sub complete_realm
{
1703 my $domain_cfg = cfs_read_file
('domains.cfg');
1705 return [ keys %{$domain_cfg->{ids
}} ];