1 package PVE
::AccessControl
;
6 use Crypt
::OpenSSL
::Random
;
7 use Crypt
::OpenSSL
::RSA
;
17 use PVE
::Tools
qw(run_command lock_file file_get_contents split_list safe_print);
18 use PVE
::Cluster
qw(cfs_register_file cfs_read_file cfs_write_file cfs_lock_file);
19 use PVE
::JSONSchema
qw(register_standard_option get_standard_option);
21 use PVE
::Auth
::Plugin
;
27 # load and initialize all plugins
29 PVE
::Auth
::AD-
>register();
30 PVE
::Auth
::LDAP-
>register();
31 PVE
::Auth
::PVE-
>register();
32 PVE
::Auth
::PAM-
>register();
33 PVE
::Auth
::Plugin-
>init();
35 # $authdir must be writable by root only!
36 my $confdir = "/etc/pve";
37 my $authdir = "$confdir/priv";
39 my $pve_www_key_fn = "$confdir/pve-www.key";
41 my $pve_auth_key_files = {
42 priv
=> "$authdir/authkey.key",
43 pub
=> "$confdir/authkey.pub",
44 pubold
=> "$confdir/authkey.pub.old",
47 my $pve_auth_key_cache = {};
49 my $ticket_lifetime = 3600*2; # 2 hours
50 # TODO: set to 24h for PVE 6.0
51 my $authkey_lifetime = 3600*0; # rotation disabled
53 Crypt
::OpenSSL
::RSA-
>import_random_seed();
55 cfs_register_file
('user.cfg',
60 PVE
::Auth
::Plugin
::verify_username
(@_);
63 sub pve_verify_realm
{
64 PVE
::Auth
::Plugin
::pve_verify_realm
(@_);
67 sub lock_user_config
{
68 my ($code, $errmsg) = @_;
70 cfs_lock_file
("user.cfg", undef, $code);
72 $errmsg ?
die "$errmsg: $err" : die $err;
76 my $cache_read_key = sub {
79 my $path = $pve_auth_key_files->{$type};
81 my $read_key_and_mtime = sub {
82 my $fh = IO
::File-
>new($path, "r");
84 return undef if !defined($fh);
87 my $pem = PVE
::Tools
::safe_read_from
($fh, 0, 0, $path);
92 if ($type eq 'pub' || $type eq 'pubold') {
93 $key = eval { Crypt
::OpenSSL
::RSA-
>new_public_key($pem); };
94 } elsif ($type eq 'priv') {
95 $key = eval { Crypt
::OpenSSL
::RSA-
>new_private_key($pem); };
97 die "Invalid authkey type '$type'\n";
100 return { key
=> $key, mtime
=> $st->mtime };
103 if (!defined($pve_auth_key_cache->{$type})) {
104 $pve_auth_key_cache->{$type} = $read_key_and_mtime->();
106 my $st = stat($path);
107 if (!$st || $st->mtime != $pve_auth_key_cache->{$type}->{mtime
}) {
108 $pve_auth_key_cache->{$type} = $read_key_and_mtime->();
112 return $pve_auth_key_cache->{$type};
118 my $type = $old ?
'pubold' : 'pub';
120 my $res = $cache_read_key->($type);
121 return undef if !defined($res);
123 return wantarray ?
($res->{key
}, $res->{mtime
}) : $res->{key
};
127 my $res = $cache_read_key->('priv');
129 if (!defined($res) || !check_authkey
(1)) {
131 $res = $cache_read_key->('priv');
134 return wantarray ?
($res->{key
}, $res->{mtime
}) : $res->{key
};
140 # skip check if non-quorate, as rotation is not possible anyway
141 return 1 if !PVE
::Cluster
::check_cfs_quorum
(1);
143 my ($pub_key, $mtime) = get_pubkey
();
145 warn "auth key pair missing, generating new one..\n" if !$quiet;
148 if (time() - $mtime >= $authkey_lifetime) {
149 warn "auth key pair too old, rotating..\n" if !$quiet;;
152 warn "auth key new enough, skipping rotation\n" if !$quiet;;
159 return if $authkey_lifetime == 0;
161 PVE
::Cluster
::cfs_lock_authkey
(undef, sub {
162 # re-check with lock to avoid double rotation in clusters
163 return if check_authkey
();
165 my $old = get_pubkey
();
169 my $pem = $old->get_public_key_x509_string();
170 PVE
::Tools
::file_set_contents
($pve_auth_key_files->{pubold
}, $pem);
172 die "Failed to store old auth key: $@\n" if $@;
175 my $new = Crypt
::OpenSSL
::RSA-
>generate_key(2048);
177 my $pem = $new->get_public_key_x509_string();
178 PVE
::Tools
::file_set_contents
($pve_auth_key_files->{pub
}, $pem);
182 warn "Failed to store new auth key - $@\n";
183 warn "Reverting to previous auth key\n";
185 my $pem = $old->get_public_key_x509_string();
186 PVE
::Tools
::file_set_contents
($pve_auth_key_files->{pub
}, $pem);
188 die "Failed to restore old auth key: $@\n" if $@;
190 die "Failed to store new auth key - $@\n";
195 my $pem = $new->get_private_key_string();
196 PVE
::Tools
::file_set_contents
($pve_auth_key_files->{priv
}, $pem);
199 warn "Failed to store new auth key - $@\n";
200 warn "Deleting auth key to force regeneration\n";
201 unlink $pve_auth_key_files->{pub
};
202 unlink $pve_auth_key_files->{priv
};
208 my $csrf_prevention_secret;
209 my $get_csrfr_secret = sub {
210 if (!$csrf_prevention_secret) {
211 my $input = PVE
::Tools
::file_get_contents
($pve_www_key_fn);
212 $csrf_prevention_secret = Digest
::SHA
::sha1_base64
($input);
214 return $csrf_prevention_secret;
217 sub assemble_csrf_prevention_token
{
220 my $secret = &$get_csrfr_secret();
222 return PVE
::Ticket
::assemble_csrf_prevention_token
($secret, $username);
225 sub verify_csrf_prevention_token
{
226 my ($username, $token, $noerr) = @_;
228 my $secret = &$get_csrfr_secret();
230 return PVE
::Ticket
::verify_csrf_prevention_token
(
231 $secret, $username, $token, -300, $ticket_lifetime, $noerr);
234 my $get_ticket_age_range = sub {
235 my ($now, $mtime, $rotated) = @_;
237 my $key_age = $now - $mtime;
238 $key_age = 0 if $key_age < 0;
241 my $max = $ticket_lifetime;
244 # ticket creation after rotation is not allowed
245 $min = $key_age - 300;
247 if ($key_age > $authkey_lifetime && $authkey_lifetime > 0) {
248 if (PVE
::Cluster
::check_cfs_quorum
(1)) {
249 # key should have been rotated, clamp range accordingly
250 $min = $key_age - $authkey_lifetime;
252 warn "Cluster not quorate - extending auth key lifetime!\n";
256 $max = $key_age + 300 if $key_age < $ticket_lifetime;
259 return undef if $min > $ticket_lifetime;
263 sub assemble_ticket
{
266 my $rsa_priv = get_privkey
();
268 return PVE
::Ticket
::assemble_rsa_ticket
($rsa_priv, 'PVE', $username);
272 my ($ticket, $noerr) = @_;
279 my ($rsa_pub, $rsa_mtime) = get_pubkey
($old);
280 return undef if !$rsa_pub;
282 my ($min, $max) = $get_ticket_age_range->($now, $rsa_mtime, $old);
283 return undef if !$min;
285 return PVE
::Ticket
::verify_rsa_ticket
(
286 $rsa_pub, 'PVE', $ticket, undef, $min, $max, 1);
289 my ($username, $age) = $check->();
291 # check with old, rotated key if current key failed
292 ($username, $age) = $check->(1) if !defined($username);
294 if (!defined($username)) {
298 # raise error via undef ticket
299 PVE
::Ticket
::verify_rsa_ticket
(undef, 'PVE');
303 return undef if !PVE
::Auth
::Plugin
::verify_username
($username, $noerr);
305 return wantarray ?
($username, $age) : $username;
309 # - they do not contain the username in plain text
310 # - they are restricted to a specific resource path (example: '/vms/100')
311 sub assemble_vnc_ticket
{
312 my ($username, $path) = @_;
314 my $rsa_priv = get_privkey
();
316 $path = normalize_path
($path);
318 my $secret_data = "$username:$path";
320 return PVE
::Ticket
::assemble_rsa_ticket
(
321 $rsa_priv, 'PVEVNC', undef, $secret_data);
324 sub verify_vnc_ticket
{
325 my ($ticket, $username, $path, $noerr) = @_;
327 my $secret_data = "$username:$path";
329 my ($rsa_pub, $rsa_mtime) = get_pubkey
();
330 if (!$rsa_pub || (time() - $rsa_mtime > $authkey_lifetime)) {
334 # raise error via undef ticket
335 PVE
::Ticket
::verify_rsa_ticket
($rsa_pub, 'PVEVNC');
339 return PVE
::Ticket
::verify_rsa_ticket
(
340 $rsa_pub, 'PVEVNC', $ticket, $secret_data, -20, 40, $noerr);
343 sub assemble_spice_ticket
{
344 my ($username, $vmid, $node) = @_;
346 my $secret = &$get_csrfr_secret();
348 return PVE
::Ticket
::assemble_spice_ticket
(
349 $secret, $username, $vmid, $node);
352 sub verify_spice_connect_url
{
353 my ($connect_str) = @_;
355 my $secret = &$get_csrfr_secret();
357 return PVE
::Ticket
::verify_spice_connect_url
($secret, $connect_str);
360 sub read_x509_subject_spice
{
364 my $bio = Net
::SSLeay
::BIO_new_file
($filename, 'r');
365 die "Could not open $filename using OpenSSL\n"
368 my $x509 = Net
::SSLeay
::PEM_read_bio_X509
($bio);
369 Net
::SSLeay
::BIO_free
($bio);
371 die "Could not parse X509 certificate in $filename\n"
374 my $nameobj = Net
::SSLeay
::X509_get_subject_name
($x509);
375 my $subject = Net
::SSLeay
::X509_NAME_oneline
($nameobj);
376 Net
::SSLeay
::X509_free
($x509);
378 # remote-viewer wants comma as seperator (not '/')
380 $subject =~ s!/(\w+=)!,$1!g;
385 # helper to generate SPICE remote-viewer configuration
386 sub remote_viewer_config
{
387 my ($authuser, $vmid, $node, $proxy, $title, $port) = @_;
390 my $host = `hostname -f` || PVE
::INotify
::nodename
();
395 my ($ticket, $proxyticket) = assemble_spice_ticket
($authuser, $vmid, $node);
397 my $filename = "/etc/pve/local/pve-ssl.pem";
398 my $subject = read_x509_subject_spice
($filename);
400 my $cacert = PVE
::Tools
::file_get_contents
("/etc/pve/pve-root-ca.pem", 8192);
401 $cacert =~ s/\n/\\n/g;
403 $proxy = "[$proxy]" if Net
::IP
::ip_is_ipv6
($proxy);
405 'secure-attention' => "Ctrl+Alt+Ins",
406 'toggle-fullscreen' => "Shift+F11",
407 'release-cursor' => "Ctrl+Alt+R",
410 host
=> $proxyticket, # this breaks tls hostname verification, so we need to use 'host-subject'
411 proxy
=> "http://$proxy:3128",
413 'host-subject' => $subject,
416 'delete-this-file' => 1,
419 return ($ticket, $proxyticket, $config);
422 sub check_user_exist
{
423 my ($usercfg, $username, $noerr) = @_;
425 $username = PVE
::Auth
::Plugin
::verify_username
($username, $noerr);
426 return undef if !$username;
428 return $usercfg->{users
}->{$username} if $usercfg && $usercfg->{users
}->{$username};
430 die "no such user ('$username')\n" if !$noerr;
435 sub check_user_enabled
{
436 my ($usercfg, $username, $noerr) = @_;
438 my $data = check_user_exist
($usercfg, $username, $noerr);
439 return undef if !$data;
441 return 1 if $data->{enable
};
443 die "user '$username' is disabled\n" if !$noerr;
448 sub verify_one_time_pw
{
449 my ($usercfg, $username, $tfa_cfg, $otp) = @_;
451 my $type = $tfa_cfg->{type
};
453 die "missing one time password for two-factor authentication '$type'\n" if !$otp;
455 # fixme: proxy support?
458 if ($type eq 'yubico') {
459 my $keys = $usercfg->{users
}->{$username}->{keys};
460 PVE
::OTP
::yubico_verify_otp
($otp, $keys, $tfa_cfg->{url
},
461 $tfa_cfg->{id
}, $tfa_cfg->{key
}, $proxy);
462 } elsif ($type eq 'oath') {
463 my $keys = $usercfg->{users
}->{$username}->{keys};
464 PVE
::OTP
::oath_verify_otp
($otp, $keys, $tfa_cfg->{step
}, $tfa_cfg->{digits
});
466 die "unknown tfa type '$type'\n";
470 # password should be utf8 encoded
471 # Note: some plugins delay/sleep if auth fails
472 sub authenticate_user
{
473 my ($username, $password, $otp) = @_;
475 die "no username specified\n" if !$username;
479 ($username, $ruid, $realm) = PVE
::Auth
::Plugin
::verify_username
($username);
481 my $usercfg = cfs_read_file
('user.cfg');
483 check_user_enabled
($usercfg, $username);
486 my $expire = $usercfg->{users
}->{$username}->{expire
};
488 die "account expired\n" if $expire && ($expire < $ctime);
490 my $domain_cfg = cfs_read_file
('domains.cfg');
492 my $cfg = $domain_cfg->{ids
}->{$realm};
493 die "auth domain '$realm' does not exists\n" if !$cfg;
494 my $plugin = PVE
::Auth
::Plugin-
>lookup($cfg->{type
});
495 $plugin->authenticate_user($cfg, $realm, $ruid, $password);
498 my $tfa_cfg = PVE
::Auth
::Plugin
::parse_tfa_config
($cfg->{tfa
});
499 verify_one_time_pw
($usercfg, $username, $tfa_cfg, $otp);
505 sub domain_set_password
{
506 my ($realm, $username, $password) = @_;
508 die "no auth domain specified" if !$realm;
510 my $domain_cfg = cfs_read_file
('domains.cfg');
512 my $cfg = $domain_cfg->{ids
}->{$realm};
513 die "auth domain '$realm' does not exist\n" if !$cfg;
514 my $plugin = PVE
::Auth
::Plugin-
>lookup($cfg->{type
});
515 $plugin->store_password($cfg, $realm, $username, $password);
519 my ($username, $usercfg, $group) = @_;
521 $usercfg->{users
}->{$username}->{groups
}->{$group} = 1;
522 $usercfg->{groups
}->{$group}->{users
}->{$username} = 1;
525 sub delete_user_group
{
526 my ($username, $usercfg) = @_;
528 foreach my $group (keys %{$usercfg->{groups
}}) {
530 delete ($usercfg->{groups
}->{$group}->{users
}->{$username})
531 if $usercfg->{groups
}->{$group}->{users
}->{$username};
535 sub delete_user_acl
{
536 my ($username, $usercfg) = @_;
538 foreach my $acl (keys %{$usercfg->{acl
}}) {
540 delete ($usercfg->{acl
}->{$acl}->{users
}->{$username})
541 if $usercfg->{acl
}->{$acl}->{users
}->{$username};
545 sub delete_group_acl
{
546 my ($group, $usercfg) = @_;
548 foreach my $acl (keys %{$usercfg->{acl
}}) {
550 delete ($usercfg->{acl
}->{$acl}->{groups
}->{$group})
551 if $usercfg->{acl
}->{$acl}->{groups
}->{$group};
555 sub delete_pool_acl
{
556 my ($pool, $usercfg) = @_;
558 my $path = "/pool/$pool";
560 delete ($usercfg->{acl
}->{$path})
563 # we automatically create some predefined roles by splitting privs
564 # into 3 groups (per category)
565 # root: only root is allowed to do that
566 # admin: an administrator can to that
567 # user: a normal user/customer can to that
577 'VM.Config.Options', # covers all other things
583 'VM.Snapshot.Rollback',
586 'VM.Config.CDROM', # change CDROM media
598 'Sys.Modify', # edit/change node settings
601 'Permissions.Modify',
613 'Datastore.Allocate',
614 'Datastore.AllocateTemplate',
617 'Datastore.AllocateSpace',
629 'Group.Allocate', # edit/change group settings
630 'Realm.AllocateUser',
638 'Pool.Allocate', # create/delete pools
645 my $valid_privs = {};
647 my $special_roles = {
648 'NoAccess' => {}, # no privileges
649 'Administrator' => $valid_privs, # all privileges
654 foreach my $cat (keys %$privgroups) {
655 my $cd = $privgroups->{$cat};
656 foreach my $p (@{$cd->{root
}}, @{$cd->{admin
}},
657 @{$cd->{user
}}, @{$cd->{audit
}}) {
658 $valid_privs->{$p} = 1;
660 foreach my $p (@{$cd->{admin
}}, @{$cd->{user
}}, @{$cd->{audit
}}) {
662 $special_roles->{"PVE${cat}Admin"}->{$p} = 1;
663 $special_roles->{"PVEAdmin"}->{$p} = 1;
665 if (scalar(@{$cd->{user
}})) {
666 foreach my $p (@{$cd->{user
}}, @{$cd->{audit
}}) {
667 $special_roles->{"PVE${cat}User"}->{$p} = 1;
670 foreach my $p (@{$cd->{audit
}}) {
671 $special_roles->{"PVEAuditor"}->{$p} = 1;
675 $special_roles->{"PVETemplateUser"} = { 'VM.Clone' => 1, 'VM.Audit' => 1 };
680 sub create_priv_properties
{
682 foreach my $priv (keys %$valid_privs) {
683 $properties->{$priv} = {
691 sub role_is_special
{
693 return (exists $special_roles->{$role}) ?
1 : 0;
697 my ($role, $usercfg, $privs) = @_;
701 die "role '$role' does not exist\n" if !$usercfg->{roles
}->{$role};
703 foreach my $priv (split_list
($privs)) {
704 if (defined ($valid_privs->{$priv})) {
705 $usercfg->{roles
}->{$role}->{$priv} = 1;
707 die "invalid privilege '$priv'\n";
719 $path = '/' if !$path;
721 $path = "/$path" if $path !~ m
|^/|;
723 return undef if $path !~ m
|^[[:alnum
:]\
.\
-\_\
/]+$|;
728 PVE
::JSONSchema
::register_format
('pve-groupid', \
&verify_groupname
);
729 sub verify_groupname
{
730 my ($groupname, $noerr) = @_;
732 if ($groupname !~ m/^[A-Za-z0-9\.\-_]+$/) {
734 die "group name '$groupname' contains invalid characters\n" if !$noerr;
742 PVE
::JSONSchema
::register_format
('pve-roleid', \
&verify_rolename
);
743 sub verify_rolename
{
744 my ($rolename, $noerr) = @_;
746 if ($rolename !~ m/^[A-Za-z0-9\.\-_]+$/) {
748 die "role name '$rolename' contains invalid characters\n" if !$noerr;
756 PVE
::JSONSchema
::register_format
('pve-poolid', \
&verify_poolname
);
757 sub verify_poolname
{
758 my ($poolname, $noerr) = @_;
760 if ($poolname !~ m/^[A-Za-z0-9\.\-_]+$/) {
762 die "pool name '$poolname' contains invalid characters\n" if !$noerr;
770 PVE
::JSONSchema
::register_format
('pve-priv', \
&verify_privname
);
771 sub verify_privname
{
772 my ($priv, $noerr) = @_;
774 if (!$valid_privs->{$priv}) {
775 die "invalid privilege '$priv'\n" if !$noerr;
783 sub userconfig_force_defaults
{
786 foreach my $r (keys %$special_roles) {
787 $cfg->{roles
}->{$r} = $special_roles->{$r};
790 # add root user if not exists
791 if (!$cfg->{users
}->{'root@pam'}) {
792 $cfg->{users
}->{'root@pam'}->{enable
} = 1;
796 sub parse_user_config
{
797 my ($filename, $raw) = @_;
801 userconfig_force_defaults
($cfg);
803 $raw = '' if !defined($raw);
804 while ($raw =~ /^\s*(.+?)\s*$/gm) {
808 foreach my $d (split (/:/, $line)) {
814 my $et = shift @data;
817 my ($user, $enable, $expire, $firstname, $lastname, $email, $comment, $keys) = @data;
819 my (undef, undef, $realm) = PVE
::Auth
::Plugin
::verify_username
($user, 1);
821 warn "user config - ignore user '$user' - invalid user name\n";
825 $enable = $enable ?
1 : 0;
827 $expire = 0 if !$expire;
829 if ($expire !~ m/^\d+$/) {
830 warn "user config - ignore user '$user' - (illegal characters in expire '$expire')\n";
833 $expire = int($expire);
835 #if (!verify_groupname ($group, 1)) {
836 # warn "user config - ignore user '$user' - invalid characters in group name\n";
840 $cfg->{users
}->{$user} = {
844 $cfg->{users
}->{$user}->{firstname
} = PVE
::Tools
::decode_text
($firstname) if $firstname;
845 $cfg->{users
}->{$user}->{lastname
} = PVE
::Tools
::decode_text
($lastname) if $lastname;
846 $cfg->{users
}->{$user}->{email
} = $email;
847 $cfg->{users
}->{$user}->{comment
} = PVE
::Tools
::decode_text
($comment) if $comment;
848 $cfg->{users
}->{$user}->{expire
} = $expire;
849 # keys: allowed yubico key ids or oath secrets (base32 encoded)
850 $cfg->{users
}->{$user}->{keys} = $keys if $keys;
852 #$cfg->{users}->{$user}->{groups}->{$group} = 1;
853 #$cfg->{groups}->{$group}->{$user} = 1;
855 } elsif ($et eq 'group') {
856 my ($group, $userlist, $comment) = @data;
858 if (!verify_groupname
($group, 1)) {
859 warn "user config - ignore group '$group' - invalid characters in group name\n";
863 # make sure to add the group (even if there are no members)
864 $cfg->{groups
}->{$group} = { users
=> {} } if !$cfg->{groups
}->{$group};
866 $cfg->{groups
}->{$group}->{comment
} = PVE
::Tools
::decode_text
($comment) if $comment;
868 foreach my $user (split_list
($userlist)) {
870 if (!PVE
::Auth
::Plugin
::verify_username
($user, 1)) {
871 warn "user config - ignore invalid group member '$user'\n";
875 if ($cfg->{users
}->{$user}) { # user exists
876 $cfg->{users
}->{$user}->{groups
}->{$group} = 1;
877 $cfg->{groups
}->{$group}->{users
}->{$user} = 1;
879 warn "user config - ignore invalid group member '$user'\n";
883 } elsif ($et eq 'role') {
884 my ($role, $privlist) = @data;
886 if (!verify_rolename
($role, 1)) {
887 warn "user config - ignore role '$role' - invalid characters in role name\n";
891 # make sure to add the role (even if there are no privileges)
892 $cfg->{roles
}->{$role} = {} if !$cfg->{roles
}->{$role};
894 foreach my $priv (split_list
($privlist)) {
895 if (defined ($valid_privs->{$priv})) {
896 $cfg->{roles
}->{$role}->{$priv} = 1;
898 warn "user config - ignore invalid priviledge '$priv'\n";
902 } elsif ($et eq 'acl') {
903 my ($propagate, $pathtxt, $uglist, $rolelist) = @data;
905 if (my $path = normalize_path
($pathtxt)) {
906 foreach my $role (split_list
($rolelist)) {
908 if (!verify_rolename
($role, 1)) {
909 warn "user config - ignore invalid role name '$role' in acl\n";
913 foreach my $ug (split_list
($uglist)) {
914 if ($ug =~ m/^@(\S+)$/) {
916 if ($cfg->{groups
}->{$group}) { # group exists
917 $cfg->{acl
}->{$path}->{groups
}->{$group}->{$role} = $propagate;
919 warn "user config - ignore invalid acl group '$group'\n";
921 } elsif (PVE
::Auth
::Plugin
::verify_username
($ug, 1)) {
922 if ($cfg->{users
}->{$ug}) { # user exists
923 $cfg->{acl
}->{$path}->{users
}->{$ug}->{$role} = $propagate;
925 warn "user config - ignore invalid acl member '$ug'\n";
928 warn "user config - invalid user/group '$ug' in acl\n";
933 warn "user config - ignore invalid path in acl '$pathtxt'\n";
935 } elsif ($et eq 'pool') {
936 my ($pool, $comment, $vmlist, $storelist) = @data;
938 if (!verify_poolname
($pool, 1)) {
939 warn "user config - ignore pool '$pool' - invalid characters in pool name\n";
943 # make sure to add the pool (even if there are no members)
944 $cfg->{pools
}->{$pool} = { vms
=> {}, storage
=> {} } if !$cfg->{pools
}->{$pool};
946 $cfg->{pools
}->{$pool}->{comment
} = PVE
::Tools
::decode_text
($comment) if $comment;
948 foreach my $vmid (split_list
($vmlist)) {
949 if ($vmid !~ m/^\d+$/) {
950 warn "user config - ignore invalid vmid '$vmid' in pool '$pool'\n";
955 if ($cfg->{vms
}->{$vmid}) {
956 warn "user config - ignore duplicate vmid '$vmid' in pool '$pool'\n";
960 $cfg->{pools
}->{$pool}->{vms
}->{$vmid} = 1;
962 # record vmid ==> pool relation
963 $cfg->{vms
}->{$vmid} = $pool;
966 foreach my $storeid (split_list
($storelist)) {
967 if ($storeid !~ m/^[a-z][a-z0-9\-\_\.]*[a-z0-9]$/i) {
968 warn "user config - ignore invalid storage '$storeid' in pool '$pool'\n";
971 $cfg->{pools
}->{$pool}->{storage
}->{$storeid} = 1;
974 warn "user config - ignore config line: $line\n";
978 userconfig_force_defaults
($cfg);
983 sub write_user_config
{
984 my ($filename, $cfg) = @_;
988 foreach my $user (keys %{$cfg->{users
}}) {
989 my $d = $cfg->{users
}->{$user};
990 my $firstname = $d->{firstname
} ? PVE
::Tools
::encode_text
($d->{firstname
}) : '';
991 my $lastname = $d->{lastname
} ? PVE
::Tools
::encode_text
($d->{lastname
}) : '';
992 my $email = $d->{email
} || '';
993 my $comment = $d->{comment
} ? PVE
::Tools
::encode_text
($d->{comment
}) : '';
994 my $expire = int($d->{expire
} || 0);
995 my $enable = $d->{enable
} ?
1 : 0;
996 my $keys = $d->{keys} ?
$d->{keys} : '';
997 $data .= "user:$user:$enable:$expire:$firstname:$lastname:$email:$comment:$keys:\n";
1002 foreach my $group (keys %{$cfg->{groups
}}) {
1003 my $d = $cfg->{groups
}->{$group};
1004 my $list = join (',', keys %{$d->{users
}});
1005 my $comment = $d->{comment
} ? PVE
::Tools
::encode_text
($d->{comment
}) : '';
1006 $data .= "group:$group:$list:$comment:\n";
1011 foreach my $pool (keys %{$cfg->{pools
}}) {
1012 my $d = $cfg->{pools
}->{$pool};
1013 my $vmlist = join (',', keys %{$d->{vms
}});
1014 my $storelist = join (',', keys %{$d->{storage
}});
1015 my $comment = $d->{comment
} ? PVE
::Tools
::encode_text
($d->{comment
}) : '';
1016 $data .= "pool:$pool:$comment:$vmlist:$storelist:\n";
1021 foreach my $role (keys %{$cfg->{roles
}}) {
1022 next if $special_roles->{$role};
1024 my $d = $cfg->{roles
}->{$role};
1025 my $list = join (',', keys %$d);
1026 $data .= "role:$role:$list:\n";
1031 foreach my $path (sort keys %{$cfg->{acl
}}) {
1032 my $d = $cfg->{acl
}->{$path};
1036 foreach my $group (keys %{$d->{groups
}}) {
1039 foreach my $role (sort keys %{$d->{groups
}->{$group}}) {
1040 my $propagate = $d->{groups
}->{$group}->{$role};
1049 $ra->{0}->{$l0}->{"\@$group"} = 1 if $l0;
1050 $ra->{1}->{$l1}->{"\@$group"} = 1 if $l1;
1053 foreach my $user (keys %{$d->{users
}}) {
1054 # no need to save, because root is always 'Administrator'
1055 next if $user eq 'root@pam';
1059 foreach my $role (sort keys %{$d->{users
}->{$user}}) {
1060 my $propagate = $d->{users
}->{$user}->{$role};
1069 $ra->{0}->{$l0}->{$user} = 1 if $l0;
1070 $ra->{1}->{$l1}->{$user} = 1 if $l1;
1073 foreach my $rolelist (sort keys %{$ra->{0}}) {
1074 my $uglist = join (',', keys %{$ra->{0}->{$rolelist}});
1075 $data .= "acl:0:$path:$uglist:$rolelist:\n";
1077 foreach my $rolelist (sort keys %{$ra->{1}}) {
1078 my $uglist = join (',', keys %{$ra->{1}->{$rolelist}});
1079 $data .= "acl:1:$path:$uglist:$rolelist:\n";
1087 my ($cfg, $user, $path) = @_;
1089 # NOTE: we do not consider pools here.
1090 # You need to use $rpcenv->roles() instead if you want that.
1092 return 'Administrator' if $user eq 'root@pam'; # root can do anything
1096 foreach my $p (sort keys %{$cfg->{acl
}}) {
1097 my $final = ($path eq $p);
1099 next if !(($p eq '/') || $final || ($path =~ m
|^$p/|));
1101 my $acl = $cfg->{acl
}->{$p};
1103 #print "CHECKACL $path $p\n";
1104 #print "ACL $path = " . Dumper ($acl);
1106 if (my $ri = $acl->{users
}->{$user}) {
1108 foreach my $role (keys %$ri) {
1109 my $propagate = $ri->{$role};
1110 if ($final || $propagate) {
1111 #print "APPLY ROLE $p $user $role\n";
1117 $perm = $new; # overwrite previous settings
1118 next; # user privs always override group privs
1123 foreach my $g (keys %{$acl->{groups
}}) {
1124 next if !$cfg->{groups
}->{$g}->{users
}->{$user};
1125 if (my $ri = $acl->{groups
}->{$g}) {
1126 foreach my $role (keys %$ri) {
1127 my $propagate = $ri->{$role};
1128 if ($final || $propagate) {
1129 #print "APPLY ROLE $p \@$g $role\n";
1137 $perm = $new; # overwrite previous settings
1142 return ('NoAccess') if defined ($perm->{NoAccess
});
1143 #return () if defined ($perm->{NoAccess});
1145 #print "permission $user $path = " . Dumper ($perm);
1147 my @ra = keys %$perm;
1149 #print "roles $user $path = " . join (',', @ra) . "\n";
1155 my ($cfg, $user, $path) = @_;
1157 $user = PVE
::Auth
::Plugin
::verify_username
($user, 1);
1158 return {} if !$user;
1160 my @ra = roles
($cfg, $user, $path);
1164 foreach my $role (@ra) {
1165 if (my $privset = $cfg->{roles
}->{$role}) {
1166 foreach my $p (keys %$privset) {
1172 #print "priviledges $user $path = " . Dumper ($privs);
1177 sub check_permissions
{
1178 my ($username, $path, $privlist) = @_;
1180 $path = normalize_path
($path);
1181 my $usercfg = cfs_read_file
('user.cfg');
1182 my $perm = permission
($usercfg, $username, $path);
1184 foreach my $priv (split_list
($privlist)) {
1185 return undef if !$perm->{$priv};
1191 sub remove_vm_access
{
1193 my $delVMaccessFn = sub {
1194 my $usercfg = cfs_read_file
("user.cfg");
1197 if (my $acl = $usercfg->{acl
}->{"/vms/$vmid"}) {
1198 delete $usercfg->{acl
}->{"/vms/$vmid"};
1201 if (my $pool = $usercfg->{vms
}->{$vmid}) {
1202 if (my $data = $usercfg->{pools
}->{$pool}) {
1203 delete $data->{vms
}->{$vmid};
1204 delete $usercfg->{vms
}->{$vmid};
1208 cfs_write_file
("user.cfg", $usercfg) if $modified;
1211 lock_user_config
($delVMaccessFn, "access permissions cleanup for VM $vmid failed");
1214 sub remove_storage_access
{
1217 my $deleteStorageAccessFn = sub {
1218 my $usercfg = cfs_read_file
("user.cfg");
1221 if (my $storage = $usercfg->{acl
}->{"/storage/$storeid"}) {
1222 delete $usercfg->{acl
}->{"/storage/$storeid"};
1225 foreach my $pool (keys %{$usercfg->{pools
}}) {
1226 delete $usercfg->{pools
}->{$pool}->{storage
}->{$storeid};
1229 cfs_write_file
("user.cfg", $usercfg) if $modified;
1232 lock_user_config
($deleteStorageAccessFn,
1233 "access permissions cleanup for storage $storeid failed");
1236 sub add_vm_to_pool
{
1237 my ($vmid, $pool) = @_;
1239 my $addVMtoPoolFn = sub {
1240 my $usercfg = cfs_read_file
("user.cfg");
1241 if (my $data = $usercfg->{pools
}->{$pool}) {
1242 $data->{vms
}->{$vmid} = 1;
1243 $usercfg->{vms
}->{$vmid} = $pool;
1244 cfs_write_file
("user.cfg", $usercfg);
1248 lock_user_config
($addVMtoPoolFn, "can't add VM $vmid to pool '$pool'");
1251 sub remove_vm_from_pool
{
1254 my $delVMfromPoolFn = sub {
1255 my $usercfg = cfs_read_file
("user.cfg");
1256 if (my $pool = $usercfg->{vms
}->{$vmid}) {
1257 if (my $data = $usercfg->{pools
}->{$pool}) {
1258 delete $data->{vms
}->{$vmid};
1259 delete $usercfg->{vms
}->{$vmid};
1260 cfs_write_file
("user.cfg", $usercfg);
1265 lock_user_config
($delVMfromPoolFn, "pool cleanup for VM $vmid failed");
1268 # bash completion helpers
1270 register_standard_option
('userid-completed',
1271 get_standard_option
('userid', { completion
=> \
&complete_username
}),
1274 sub complete_username
{
1276 my $user_cfg = cfs_read_file
('user.cfg');
1278 return [ keys %{$user_cfg->{users
}} ];
1281 sub complete_group
{
1283 my $user_cfg = cfs_read_file
('user.cfg');
1285 return [ keys %{$user_cfg->{groups
}} ];
1288 sub complete_realm
{
1290 my $domain_cfg = cfs_read_file
('domains.cfg');
1292 return [ keys %{$domain_cfg->{ids
}} ];