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 # TODO: set to 24h for PVE 6.0
52 my $authkey_lifetime = 3600*0; # rotation disabled
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;
152 if (time() - $mtime >= $authkey_lifetime) {
153 warn "auth key pair too old, rotating..\n" if !$quiet;;
156 warn "auth key new enough, skipping rotation\n" if !$quiet;;
163 return if $authkey_lifetime == 0;
165 PVE
::Cluster
::cfs_lock_authkey
(undef, sub {
166 # re-check with lock to avoid double rotation in clusters
167 return if check_authkey
();
169 my $old = get_pubkey
();
173 my $pem = $old->get_public_key_x509_string();
174 PVE
::Tools
::file_set_contents
($pve_auth_key_files->{pubold
}, $pem);
176 die "Failed to store old auth key: $@\n" if $@;
179 my $new = Crypt
::OpenSSL
::RSA-
>generate_key(2048);
181 my $pem = $new->get_public_key_x509_string();
182 PVE
::Tools
::file_set_contents
($pve_auth_key_files->{pub
}, $pem);
186 warn "Failed to store new auth key - $@\n";
187 warn "Reverting to previous auth key\n";
189 my $pem = $old->get_public_key_x509_string();
190 PVE
::Tools
::file_set_contents
($pve_auth_key_files->{pub
}, $pem);
192 die "Failed to restore old auth key: $@\n" if $@;
194 die "Failed to store new auth key - $@\n";
199 my $pem = $new->get_private_key_string();
200 PVE
::Tools
::file_set_contents
($pve_auth_key_files->{priv
}, $pem);
203 warn "Failed to store new auth key - $@\n";
204 warn "Deleting auth key to force regeneration\n";
205 unlink $pve_auth_key_files->{pub
};
206 unlink $pve_auth_key_files->{priv
};
212 my $csrf_prevention_secret;
213 my $get_csrfr_secret = sub {
214 if (!$csrf_prevention_secret) {
215 my $input = PVE
::Tools
::file_get_contents
($pve_www_key_fn);
216 $csrf_prevention_secret = Digest
::SHA
::sha1_base64
($input);
218 return $csrf_prevention_secret;
221 sub assemble_csrf_prevention_token
{
224 my $secret = &$get_csrfr_secret();
226 return PVE
::Ticket
::assemble_csrf_prevention_token
($secret, $username);
229 sub verify_csrf_prevention_token
{
230 my ($username, $token, $noerr) = @_;
232 my $secret = &$get_csrfr_secret();
234 return PVE
::Ticket
::verify_csrf_prevention_token
(
235 $secret, $username, $token, -300, $ticket_lifetime, $noerr);
238 my $get_ticket_age_range = sub {
239 my ($now, $mtime, $rotated) = @_;
241 my $key_age = $now - $mtime;
242 $key_age = 0 if $key_age < 0;
245 my $max = $ticket_lifetime;
248 # ticket creation after rotation is not allowed
249 $min = $key_age - 300;
251 if ($key_age > $authkey_lifetime && $authkey_lifetime > 0) {
252 if (PVE
::Cluster
::check_cfs_quorum
(1)) {
253 # key should have been rotated, clamp range accordingly
254 $min = $key_age - $authkey_lifetime;
256 warn "Cluster not quorate - extending auth key lifetime!\n";
260 $max = $key_age + 300 if $key_age < $ticket_lifetime;
263 return undef if $min > $ticket_lifetime;
267 sub assemble_ticket
{
270 my $rsa_priv = get_privkey
();
272 return PVE
::Ticket
::assemble_rsa_ticket
($rsa_priv, 'PVE', $data);
276 my ($ticket, $noerr) = @_;
283 my ($rsa_pub, $rsa_mtime) = get_pubkey
($old);
284 return undef if !$rsa_pub;
286 my ($min, $max) = $get_ticket_age_range->($now, $rsa_mtime, $old);
287 return undef if !$min;
289 return PVE
::Ticket
::verify_rsa_ticket
(
290 $rsa_pub, 'PVE', $ticket, undef, $min, $max, 1);
293 my ($data, $age) = $check->();
295 # check with old, rotated key if current key failed
296 ($data, $age) = $check->(1) if !defined($data);
298 my $auth_failure = sub {
302 # raise error via undef ticket
303 PVE
::Ticket
::verify_rsa_ticket
(undef, 'PVE');
307 if (!defined($data)) {
308 return $auth_failure->();
311 my ($username, $tfa_info);
312 if ($data =~ m{^u2f!([^!]+)!([0-9a-zA-Z/.=_\-+]+)$}) {
313 # Ticket for u2f-users:
314 ($username, my $challenge) = ($1, $2);
315 if ($challenge eq 'verified') {
316 # u2f challenge was completed
318 } elsif (!wantarray) {
319 # The caller is not aware there could be an ongoing challenge,
320 # so we treat this ticket as invalid:
321 return $auth_failure->();
325 challenge
=> $challenge,
327 } elsif ($data =~ /^tfa!(.*)$/) {
328 # TOTP and Yubico don't require a challenge so this is the generic
329 # 'missing 2nd factor ticket'
331 $tfa_info = { type
=> 'tfa' };
333 # Regular ticket (full access)
337 return undef if !PVE
::Auth
::Plugin
::verify_username
($username, $noerr);
339 return wantarray ?
($username, $age, $tfa_info) : $username;
343 # - they do not contain the username in plain text
344 # - they are restricted to a specific resource path (example: '/vms/100')
345 sub assemble_vnc_ticket
{
346 my ($username, $path) = @_;
348 my $rsa_priv = get_privkey
();
350 $path = normalize_path
($path);
352 my $secret_data = "$username:$path";
354 return PVE
::Ticket
::assemble_rsa_ticket
(
355 $rsa_priv, 'PVEVNC', undef, $secret_data);
358 sub verify_vnc_ticket
{
359 my ($ticket, $username, $path, $noerr) = @_;
361 my $secret_data = "$username:$path";
363 my ($rsa_pub, $rsa_mtime) = get_pubkey
();
364 if (!$rsa_pub || (time() - $rsa_mtime > $authkey_lifetime && $authkey_lifetime > 0)) {
368 # raise error via undef ticket
369 PVE
::Ticket
::verify_rsa_ticket
($rsa_pub, 'PVEVNC');
373 return PVE
::Ticket
::verify_rsa_ticket
(
374 $rsa_pub, 'PVEVNC', $ticket, $secret_data, -20, 40, $noerr);
377 sub assemble_spice_ticket
{
378 my ($username, $vmid, $node) = @_;
380 my $secret = &$get_csrfr_secret();
382 return PVE
::Ticket
::assemble_spice_ticket
(
383 $secret, $username, $vmid, $node);
386 sub verify_spice_connect_url
{
387 my ($connect_str) = @_;
389 my $secret = &$get_csrfr_secret();
391 return PVE
::Ticket
::verify_spice_connect_url
($secret, $connect_str);
394 sub read_x509_subject_spice
{
398 my $bio = Net
::SSLeay
::BIO_new_file
($filename, 'r');
399 die "Could not open $filename using OpenSSL\n"
402 my $x509 = Net
::SSLeay
::PEM_read_bio_X509
($bio);
403 Net
::SSLeay
::BIO_free
($bio);
405 die "Could not parse X509 certificate in $filename\n"
408 my $nameobj = Net
::SSLeay
::X509_get_subject_name
($x509);
409 my $subject = Net
::SSLeay
::X509_NAME_oneline
($nameobj);
410 Net
::SSLeay
::X509_free
($x509);
412 # remote-viewer wants comma as seperator (not '/')
414 $subject =~ s!/(\w+=)!,$1!g;
419 # helper to generate SPICE remote-viewer configuration
420 sub remote_viewer_config
{
421 my ($authuser, $vmid, $node, $proxy, $title, $port) = @_;
424 my $host = `hostname -f` || PVE
::INotify
::nodename
();
429 my ($ticket, $proxyticket) = assemble_spice_ticket
($authuser, $vmid, $node);
431 my $filename = "/etc/pve/local/pve-ssl.pem";
432 my $subject = read_x509_subject_spice
($filename);
434 my $cacert = PVE
::Tools
::file_get_contents
("/etc/pve/pve-root-ca.pem", 8192);
435 $cacert =~ s/\n/\\n/g;
437 $proxy = "[$proxy]" if Net
::IP
::ip_is_ipv6
($proxy);
439 'secure-attention' => "Ctrl+Alt+Ins",
440 'toggle-fullscreen' => "Shift+F11",
441 'release-cursor' => "Ctrl+Alt+R",
444 host
=> $proxyticket, # this breaks tls hostname verification, so we need to use 'host-subject'
445 proxy
=> "http://$proxy:3128",
447 'host-subject' => $subject,
450 'delete-this-file' => 1,
453 return ($ticket, $proxyticket, $config);
456 sub check_user_exist
{
457 my ($usercfg, $username, $noerr) = @_;
459 $username = PVE
::Auth
::Plugin
::verify_username
($username, $noerr);
460 return undef if !$username;
462 return $usercfg->{users
}->{$username} if $usercfg && $usercfg->{users
}->{$username};
464 die "no such user ('$username')\n" if !$noerr;
469 sub check_user_enabled
{
470 my ($usercfg, $username, $noerr) = @_;
472 my $data = check_user_exist
($usercfg, $username, $noerr);
473 return undef if !$data;
475 return 1 if $data->{enable
};
477 die "user '$username' is disabled\n" if !$noerr;
482 sub verify_one_time_pw
{
483 my ($type, $username, $keys, $tfa_cfg, $otp) = @_;
485 die "missing one time password for two-factor authentication '$type'\n" if !$otp;
487 # fixme: proxy support?
490 if ($type eq 'yubico') {
491 PVE
::OTP
::yubico_verify_otp
($otp, $keys, $tfa_cfg->{url
},
492 $tfa_cfg->{id
}, $tfa_cfg->{key
}, $proxy);
493 } elsif ($type eq 'oath') {
494 PVE
::OTP
::oath_verify_otp
($otp, $keys, $tfa_cfg->{step
}, $tfa_cfg->{digits
});
496 die "unknown tfa type '$type'\n";
500 # password should be utf8 encoded
501 # Note: some plugins delay/sleep if auth fails
502 sub authenticate_user
{
503 my ($username, $password, $otp) = @_;
505 die "no username specified\n" if !$username;
509 ($username, $ruid, $realm) = PVE
::Auth
::Plugin
::verify_username
($username);
511 my $usercfg = cfs_read_file
('user.cfg');
513 check_user_enabled
($usercfg, $username);
516 my $expire = $usercfg->{users
}->{$username}->{expire
};
518 die "account expired\n" if $expire && ($expire < $ctime);
520 my $domain_cfg = cfs_read_file
('domains.cfg');
522 my $cfg = $domain_cfg->{ids
}->{$realm};
523 die "auth domain '$realm' does not exists\n" if !$cfg;
524 my $plugin = PVE
::Auth
::Plugin-
>lookup($cfg->{type
});
525 $plugin->authenticate_user($cfg, $realm, $ruid, $password);
527 my ($type, $tfa_data) = user_get_tfa
($username, $realm);
529 if ($type eq 'u2f') {
530 # Note that if the user did not manage to complete the initial u2f registration
531 # challenge we have a hash containing a 'challenge' entry in the user's tfa.cfg entry:
532 $tfa_data = undef if exists $tfa_data->{challenge
};
533 } elsif (!defined($otp)) {
534 # The user requires a 2nd factor but has not provided one. Return success but
535 # don't clear $tfa_data.
537 my $keys = $tfa_data->{keys};
538 my $tfa_cfg = $tfa_data->{config
};
539 verify_one_time_pw
($type, $username, $keys, $tfa_cfg, $otp);
543 # Return the type along with the rest:
552 return wantarray ?
($username, $tfa_data) : $username;
555 sub domain_set_password
{
556 my ($realm, $username, $password) = @_;
558 die "no auth domain specified" if !$realm;
560 my $domain_cfg = cfs_read_file
('domains.cfg');
562 my $cfg = $domain_cfg->{ids
}->{$realm};
563 die "auth domain '$realm' does not exist\n" if !$cfg;
564 my $plugin = PVE
::Auth
::Plugin-
>lookup($cfg->{type
});
565 $plugin->store_password($cfg, $realm, $username, $password);
569 my ($username, $usercfg, $group) = @_;
571 $usercfg->{users
}->{$username}->{groups
}->{$group} = 1;
572 $usercfg->{groups
}->{$group}->{users
}->{$username} = 1;
575 sub delete_user_group
{
576 my ($username, $usercfg) = @_;
578 foreach my $group (keys %{$usercfg->{groups
}}) {
580 delete ($usercfg->{groups
}->{$group}->{users
}->{$username})
581 if $usercfg->{groups
}->{$group}->{users
}->{$username};
585 sub delete_user_acl
{
586 my ($username, $usercfg) = @_;
588 foreach my $acl (keys %{$usercfg->{acl
}}) {
590 delete ($usercfg->{acl
}->{$acl}->{users
}->{$username})
591 if $usercfg->{acl
}->{$acl}->{users
}->{$username};
595 sub delete_group_acl
{
596 my ($group, $usercfg) = @_;
598 foreach my $acl (keys %{$usercfg->{acl
}}) {
600 delete ($usercfg->{acl
}->{$acl}->{groups
}->{$group})
601 if $usercfg->{acl
}->{$acl}->{groups
}->{$group};
605 sub delete_pool_acl
{
606 my ($pool, $usercfg) = @_;
608 my $path = "/pool/$pool";
610 delete ($usercfg->{acl
}->{$path})
613 # we automatically create some predefined roles by splitting privs
614 # into 3 groups (per category)
615 # root: only root is allowed to do that
616 # admin: an administrator can to that
617 # user: a normal user/customer can to that
627 'VM.Config.Options', # covers all other things
633 'VM.Snapshot.Rollback',
636 'VM.Config.CDROM', # change CDROM media
648 'Sys.Modify', # edit/change node settings
651 'Permissions.Modify',
663 'Datastore.Allocate',
664 'Datastore.AllocateTemplate',
667 'Datastore.AllocateSpace',
679 'Group.Allocate', # edit/change group settings
680 'Realm.AllocateUser',
688 'Pool.Allocate', # create/delete pools
695 my $valid_privs = {};
697 my $special_roles = {
698 'NoAccess' => {}, # no privileges
699 'Administrator' => $valid_privs, # all privileges
704 foreach my $cat (keys %$privgroups) {
705 my $cd = $privgroups->{$cat};
706 foreach my $p (@{$cd->{root
}}, @{$cd->{admin
}},
707 @{$cd->{user
}}, @{$cd->{audit
}}) {
708 $valid_privs->{$p} = 1;
710 foreach my $p (@{$cd->{admin
}}, @{$cd->{user
}}, @{$cd->{audit
}}) {
712 $special_roles->{"PVE${cat}Admin"}->{$p} = 1;
713 $special_roles->{"PVEAdmin"}->{$p} = 1;
715 if (scalar(@{$cd->{user
}})) {
716 foreach my $p (@{$cd->{user
}}, @{$cd->{audit
}}) {
717 $special_roles->{"PVE${cat}User"}->{$p} = 1;
720 foreach my $p (@{$cd->{audit
}}) {
721 $special_roles->{"PVEAuditor"}->{$p} = 1;
725 $special_roles->{"PVETemplateUser"} = { 'VM.Clone' => 1, 'VM.Audit' => 1 };
730 sub create_priv_properties
{
732 foreach my $priv (keys %$valid_privs) {
733 $properties->{$priv} = {
741 sub role_is_special
{
743 return (exists $special_roles->{$role}) ?
1 : 0;
747 my ($role, $usercfg, $privs) = @_;
751 die "role '$role' does not exist\n" if !$usercfg->{roles
}->{$role};
753 foreach my $priv (split_list
($privs)) {
754 if (defined ($valid_privs->{$priv})) {
755 $usercfg->{roles
}->{$role}->{$priv} = 1;
757 die "invalid privilege '$priv'\n";
769 $path = '/' if !$path;
771 $path = "/$path" if $path !~ m
|^/|;
773 return undef if $path !~ m
|^[[:alnum
:]\
.\
-\_\
/]+$|;
778 PVE
::JSONSchema
::register_format
('pve-groupid', \
&verify_groupname
);
779 sub verify_groupname
{
780 my ($groupname, $noerr) = @_;
782 if ($groupname !~ m/^[A-Za-z0-9\.\-_]+$/) {
784 die "group name '$groupname' contains invalid characters\n" if !$noerr;
792 PVE
::JSONSchema
::register_format
('pve-roleid', \
&verify_rolename
);
793 sub verify_rolename
{
794 my ($rolename, $noerr) = @_;
796 if ($rolename !~ m/^[A-Za-z0-9\.\-_]+$/) {
798 die "role name '$rolename' contains invalid characters\n" if !$noerr;
806 PVE
::JSONSchema
::register_format
('pve-poolid', \
&verify_poolname
);
807 sub verify_poolname
{
808 my ($poolname, $noerr) = @_;
810 if ($poolname !~ m/^[A-Za-z0-9\.\-_]+$/) {
812 die "pool name '$poolname' contains invalid characters\n" if !$noerr;
820 PVE
::JSONSchema
::register_format
('pve-priv', \
&verify_privname
);
821 sub verify_privname
{
822 my ($priv, $noerr) = @_;
824 if (!$valid_privs->{$priv}) {
825 die "invalid privilege '$priv'\n" if !$noerr;
833 sub userconfig_force_defaults
{
836 foreach my $r (keys %$special_roles) {
837 $cfg->{roles
}->{$r} = $special_roles->{$r};
840 # add root user if not exists
841 if (!$cfg->{users
}->{'root@pam'}) {
842 $cfg->{users
}->{'root@pam'}->{enable
} = 1;
846 sub parse_user_config
{
847 my ($filename, $raw) = @_;
851 userconfig_force_defaults
($cfg);
853 $raw = '' if !defined($raw);
854 while ($raw =~ /^\s*(.+?)\s*$/gm) {
858 foreach my $d (split (/:/, $line)) {
864 my $et = shift @data;
867 my ($user, $enable, $expire, $firstname, $lastname, $email, $comment, $keys) = @data;
869 my (undef, undef, $realm) = PVE
::Auth
::Plugin
::verify_username
($user, 1);
871 warn "user config - ignore user '$user' - invalid user name\n";
875 $enable = $enable ?
1 : 0;
877 $expire = 0 if !$expire;
879 if ($expire !~ m/^\d+$/) {
880 warn "user config - ignore user '$user' - (illegal characters in expire '$expire')\n";
883 $expire = int($expire);
885 #if (!verify_groupname ($group, 1)) {
886 # warn "user config - ignore user '$user' - invalid characters in group name\n";
890 $cfg->{users
}->{$user} = {
894 $cfg->{users
}->{$user}->{firstname
} = PVE
::Tools
::decode_text
($firstname) if $firstname;
895 $cfg->{users
}->{$user}->{lastname
} = PVE
::Tools
::decode_text
($lastname) if $lastname;
896 $cfg->{users
}->{$user}->{email
} = $email;
897 $cfg->{users
}->{$user}->{comment
} = PVE
::Tools
::decode_text
($comment) if $comment;
898 $cfg->{users
}->{$user}->{expire
} = $expire;
899 # keys: allowed yubico key ids or oath secrets (base32 encoded)
900 $cfg->{users
}->{$user}->{keys} = $keys if $keys;
902 #$cfg->{users}->{$user}->{groups}->{$group} = 1;
903 #$cfg->{groups}->{$group}->{$user} = 1;
905 } elsif ($et eq 'group') {
906 my ($group, $userlist, $comment) = @data;
908 if (!verify_groupname
($group, 1)) {
909 warn "user config - ignore group '$group' - invalid characters in group name\n";
913 # make sure to add the group (even if there are no members)
914 $cfg->{groups
}->{$group} = { users
=> {} } if !$cfg->{groups
}->{$group};
916 $cfg->{groups
}->{$group}->{comment
} = PVE
::Tools
::decode_text
($comment) if $comment;
918 foreach my $user (split_list
($userlist)) {
920 if (!PVE
::Auth
::Plugin
::verify_username
($user, 1)) {
921 warn "user config - ignore invalid group member '$user'\n";
925 if ($cfg->{users
}->{$user}) { # user exists
926 $cfg->{users
}->{$user}->{groups
}->{$group} = 1;
927 $cfg->{groups
}->{$group}->{users
}->{$user} = 1;
929 warn "user config - ignore invalid group member '$user'\n";
933 } elsif ($et eq 'role') {
934 my ($role, $privlist) = @data;
936 if (!verify_rolename
($role, 1)) {
937 warn "user config - ignore role '$role' - invalid characters in role name\n";
941 # make sure to add the role (even if there are no privileges)
942 $cfg->{roles
}->{$role} = {} if !$cfg->{roles
}->{$role};
944 foreach my $priv (split_list
($privlist)) {
945 if (defined ($valid_privs->{$priv})) {
946 $cfg->{roles
}->{$role}->{$priv} = 1;
948 warn "user config - ignore invalid priviledge '$priv'\n";
952 } elsif ($et eq 'acl') {
953 my ($propagate, $pathtxt, $uglist, $rolelist) = @data;
955 if (my $path = normalize_path
($pathtxt)) {
956 foreach my $role (split_list
($rolelist)) {
958 if (!verify_rolename
($role, 1)) {
959 warn "user config - ignore invalid role name '$role' in acl\n";
963 foreach my $ug (split_list
($uglist)) {
964 if ($ug =~ m/^@(\S+)$/) {
966 if ($cfg->{groups
}->{$group}) { # group exists
967 $cfg->{acl
}->{$path}->{groups
}->{$group}->{$role} = $propagate;
969 warn "user config - ignore invalid acl group '$group'\n";
971 } elsif (PVE
::Auth
::Plugin
::verify_username
($ug, 1)) {
972 if ($cfg->{users
}->{$ug}) { # user exists
973 $cfg->{acl
}->{$path}->{users
}->{$ug}->{$role} = $propagate;
975 warn "user config - ignore invalid acl member '$ug'\n";
978 warn "user config - invalid user/group '$ug' in acl\n";
983 warn "user config - ignore invalid path in acl '$pathtxt'\n";
985 } elsif ($et eq 'pool') {
986 my ($pool, $comment, $vmlist, $storelist) = @data;
988 if (!verify_poolname
($pool, 1)) {
989 warn "user config - ignore pool '$pool' - invalid characters in pool name\n";
993 # make sure to add the pool (even if there are no members)
994 $cfg->{pools
}->{$pool} = { vms
=> {}, storage
=> {} } if !$cfg->{pools
}->{$pool};
996 $cfg->{pools
}->{$pool}->{comment
} = PVE
::Tools
::decode_text
($comment) if $comment;
998 foreach my $vmid (split_list
($vmlist)) {
999 if ($vmid !~ m/^\d+$/) {
1000 warn "user config - ignore invalid vmid '$vmid' in pool '$pool'\n";
1005 if ($cfg->{vms
}->{$vmid}) {
1006 warn "user config - ignore duplicate vmid '$vmid' in pool '$pool'\n";
1010 $cfg->{pools
}->{$pool}->{vms
}->{$vmid} = 1;
1012 # record vmid ==> pool relation
1013 $cfg->{vms
}->{$vmid} = $pool;
1016 foreach my $storeid (split_list
($storelist)) {
1017 if ($storeid !~ m/^[a-z][a-z0-9\-\_\.]*[a-z0-9]$/i) {
1018 warn "user config - ignore invalid storage '$storeid' in pool '$pool'\n";
1021 $cfg->{pools
}->{$pool}->{storage
}->{$storeid} = 1;
1024 warn "user config - ignore config line: $line\n";
1028 userconfig_force_defaults
($cfg);
1033 sub write_user_config
{
1034 my ($filename, $cfg) = @_;
1038 foreach my $user (keys %{$cfg->{users
}}) {
1039 my $d = $cfg->{users
}->{$user};
1040 my $firstname = $d->{firstname
} ? PVE
::Tools
::encode_text
($d->{firstname
}) : '';
1041 my $lastname = $d->{lastname
} ? PVE
::Tools
::encode_text
($d->{lastname
}) : '';
1042 my $email = $d->{email
} || '';
1043 my $comment = $d->{comment
} ? PVE
::Tools
::encode_text
($d->{comment
}) : '';
1044 my $expire = int($d->{expire
} || 0);
1045 my $enable = $d->{enable
} ?
1 : 0;
1046 my $keys = $d->{keys} ?
$d->{keys} : '';
1047 $data .= "user:$user:$enable:$expire:$firstname:$lastname:$email:$comment:$keys:\n";
1052 foreach my $group (keys %{$cfg->{groups
}}) {
1053 my $d = $cfg->{groups
}->{$group};
1054 my $list = join (',', keys %{$d->{users
}});
1055 my $comment = $d->{comment
} ? PVE
::Tools
::encode_text
($d->{comment
}) : '';
1056 $data .= "group:$group:$list:$comment:\n";
1061 foreach my $pool (keys %{$cfg->{pools
}}) {
1062 my $d = $cfg->{pools
}->{$pool};
1063 my $vmlist = join (',', keys %{$d->{vms
}});
1064 my $storelist = join (',', keys %{$d->{storage
}});
1065 my $comment = $d->{comment
} ? PVE
::Tools
::encode_text
($d->{comment
}) : '';
1066 $data .= "pool:$pool:$comment:$vmlist:$storelist:\n";
1071 foreach my $role (keys %{$cfg->{roles
}}) {
1072 next if $special_roles->{$role};
1074 my $d = $cfg->{roles
}->{$role};
1075 my $list = join (',', keys %$d);
1076 $data .= "role:$role:$list:\n";
1081 foreach my $path (sort keys %{$cfg->{acl
}}) {
1082 my $d = $cfg->{acl
}->{$path};
1086 foreach my $group (keys %{$d->{groups
}}) {
1089 foreach my $role (sort keys %{$d->{groups
}->{$group}}) {
1090 my $propagate = $d->{groups
}->{$group}->{$role};
1099 $ra->{0}->{$l0}->{"\@$group"} = 1 if $l0;
1100 $ra->{1}->{$l1}->{"\@$group"} = 1 if $l1;
1103 foreach my $user (keys %{$d->{users
}}) {
1104 # no need to save, because root is always 'Administrator'
1105 next if $user eq 'root@pam';
1109 foreach my $role (sort keys %{$d->{users
}->{$user}}) {
1110 my $propagate = $d->{users
}->{$user}->{$role};
1119 $ra->{0}->{$l0}->{$user} = 1 if $l0;
1120 $ra->{1}->{$l1}->{$user} = 1 if $l1;
1123 foreach my $rolelist (sort keys %{$ra->{0}}) {
1124 my $uglist = join (',', keys %{$ra->{0}->{$rolelist}});
1125 $data .= "acl:0:$path:$uglist:$rolelist:\n";
1127 foreach my $rolelist (sort keys %{$ra->{1}}) {
1128 my $uglist = join (',', keys %{$ra->{1}->{$rolelist}});
1129 $data .= "acl:1:$path:$uglist:$rolelist:\n";
1136 # The TFA configuration in priv/tfa.cfg format contains one line per user of
1139 # DATA is a base64 encoded json string and its format depends on the type.
1140 sub parse_priv_tfa_config
{
1141 my ($filename, $raw) = @_;
1144 my $cfg = { users
=> $users };
1146 $raw = '' if !defined($raw);
1147 while ($raw =~ /^\s*(.+?)\s*$/gm) {
1149 my ($user, $type, $data) = split(/:/, $line, 3);
1151 my (undef, undef, $realm) = PVE
::Auth
::Plugin
::verify_username
($user, 1);
1153 warn "user tfa config - ignore user '$user' - invalid user name\n";
1157 $data = decode_json
(decode_base64
($data));
1168 sub write_priv_tfa_config
{
1169 my ($filename, $cfg) = @_;
1173 my $users = $cfg->{users
};
1174 foreach my $user (sort keys %$users) {
1175 my $info = $users->{$user};
1176 next if !%$info; # skip empty entries
1178 $info = {%$info}; # copy to verify contents:
1180 my $type = delete $info->{type
};
1181 my $data = delete $info->{data
};
1183 if (my @keys = keys %$info) {
1184 die "invalid keys in TFA config for user $user: " . join(', ', @keys) . "\n";
1187 $data = encode_base64
(encode_json
($data), '');
1188 $output .= "${user}:${type}:${data}\n";
1195 my ($cfg, $user, $path) = @_;
1197 # NOTE: we do not consider pools here.
1198 # You need to use $rpcenv->roles() instead if you want that.
1200 return 'Administrator' if $user eq 'root@pam'; # root can do anything
1204 foreach my $p (sort keys %{$cfg->{acl
}}) {
1205 my $final = ($path eq $p);
1207 next if !(($p eq '/') || $final || ($path =~ m
|^$p/|));
1209 my $acl = $cfg->{acl
}->{$p};
1211 #print "CHECKACL $path $p\n";
1212 #print "ACL $path = " . Dumper ($acl);
1214 if (my $ri = $acl->{users
}->{$user}) {
1216 foreach my $role (keys %$ri) {
1217 my $propagate = $ri->{$role};
1218 if ($final || $propagate) {
1219 #print "APPLY ROLE $p $user $role\n";
1225 $perm = $new; # overwrite previous settings
1226 next; # user privs always override group privs
1231 foreach my $g (keys %{$acl->{groups
}}) {
1232 next if !$cfg->{groups
}->{$g}->{users
}->{$user};
1233 if (my $ri = $acl->{groups
}->{$g}) {
1234 foreach my $role (keys %$ri) {
1235 my $propagate = $ri->{$role};
1236 if ($final || $propagate) {
1237 #print "APPLY ROLE $p \@$g $role\n";
1245 $perm = $new; # overwrite previous settings
1250 return ('NoAccess') if defined ($perm->{NoAccess
});
1251 #return () if defined ($perm->{NoAccess});
1253 #print "permission $user $path = " . Dumper ($perm);
1255 my @ra = keys %$perm;
1257 #print "roles $user $path = " . join (',', @ra) . "\n";
1263 my ($cfg, $user, $path) = @_;
1265 $user = PVE
::Auth
::Plugin
::verify_username
($user, 1);
1266 return {} if !$user;
1268 my @ra = roles
($cfg, $user, $path);
1272 foreach my $role (@ra) {
1273 if (my $privset = $cfg->{roles
}->{$role}) {
1274 foreach my $p (keys %$privset) {
1280 #print "priviledges $user $path = " . Dumper ($privs);
1285 sub check_permissions
{
1286 my ($username, $path, $privlist) = @_;
1288 $path = normalize_path
($path);
1289 my $usercfg = cfs_read_file
('user.cfg');
1290 my $perm = permission
($usercfg, $username, $path);
1292 foreach my $priv (split_list
($privlist)) {
1293 return undef if !$perm->{$priv};
1299 sub remove_vm_access
{
1301 my $delVMaccessFn = sub {
1302 my $usercfg = cfs_read_file
("user.cfg");
1305 if (my $acl = $usercfg->{acl
}->{"/vms/$vmid"}) {
1306 delete $usercfg->{acl
}->{"/vms/$vmid"};
1309 if (my $pool = $usercfg->{vms
}->{$vmid}) {
1310 if (my $data = $usercfg->{pools
}->{$pool}) {
1311 delete $data->{vms
}->{$vmid};
1312 delete $usercfg->{vms
}->{$vmid};
1316 cfs_write_file
("user.cfg", $usercfg) if $modified;
1319 lock_user_config
($delVMaccessFn, "access permissions cleanup for VM $vmid failed");
1322 sub remove_storage_access
{
1325 my $deleteStorageAccessFn = sub {
1326 my $usercfg = cfs_read_file
("user.cfg");
1329 if (my $storage = $usercfg->{acl
}->{"/storage/$storeid"}) {
1330 delete $usercfg->{acl
}->{"/storage/$storeid"};
1333 foreach my $pool (keys %{$usercfg->{pools
}}) {
1334 delete $usercfg->{pools
}->{$pool}->{storage
}->{$storeid};
1337 cfs_write_file
("user.cfg", $usercfg) if $modified;
1340 lock_user_config
($deleteStorageAccessFn,
1341 "access permissions cleanup for storage $storeid failed");
1344 sub add_vm_to_pool
{
1345 my ($vmid, $pool) = @_;
1347 my $addVMtoPoolFn = sub {
1348 my $usercfg = cfs_read_file
("user.cfg");
1349 if (my $data = $usercfg->{pools
}->{$pool}) {
1350 $data->{vms
}->{$vmid} = 1;
1351 $usercfg->{vms
}->{$vmid} = $pool;
1352 cfs_write_file
("user.cfg", $usercfg);
1356 lock_user_config
($addVMtoPoolFn, "can't add VM $vmid to pool '$pool'");
1359 sub remove_vm_from_pool
{
1362 my $delVMfromPoolFn = sub {
1363 my $usercfg = cfs_read_file
("user.cfg");
1364 if (my $pool = $usercfg->{vms
}->{$vmid}) {
1365 if (my $data = $usercfg->{pools
}->{$pool}) {
1366 delete $data->{vms
}->{$vmid};
1367 delete $usercfg->{vms
}->{$vmid};
1368 cfs_write_file
("user.cfg", $usercfg);
1373 lock_user_config
($delVMfromPoolFn, "pool cleanup for VM $vmid failed");
1376 my $USER_CONTROLLED_TFA_TYPES = {
1381 # Delete an entry by setting $data=undef in which case $type is ignored.
1382 # Otherwise both must be valid.
1384 my ($userid, $realm, $type, $data, $cached_usercfg, $cached_domaincfg) = @_;
1386 if (defined($data) && !defined($type)) {
1387 # This is an internal usage error and should not happen
1388 die "cannot set tfa data without a type\n";
1391 my $user_cfg = $cached_usercfg || cfs_read_file
('user.cfg');
1392 my $user = $user_cfg->{users
}->{$userid}
1393 or die "user '$userid' not found\n";
1395 my $domain_cfg = $cached_domaincfg || cfs_read_file
('domains.cfg');
1396 my $realm_cfg = $domain_cfg->{ids
}->{$realm};
1397 die "auth domain '$realm' does not exist\n" if !$realm_cfg;
1399 my $realm_tfa = $realm_cfg->{tfa
};
1400 if (defined($realm_tfa)) {
1401 $realm_tfa = PVE
::Auth
::Plugin
::parse_tfa_config
($realm_tfa);
1402 # If the realm has a TFA setting, we're only allowed to use that.
1403 if (defined($data)) {
1404 my $required_type = $realm_tfa->{type
};
1405 if ($required_type ne $type) {
1406 die "realm '$realm' only allows TFA of type '$required_type\n";
1409 if (defined($data->{config
})) {
1410 # XXX: Is it enough if the type matches? Or should the configuration also match?
1413 # realm-configured tfa always uses a simple key list, so use the user.cfg
1414 $user->{keys} = $data->{keys};
1416 die "realm '$realm' does not allow removing the 2nd factor\n";
1419 # Without a realm-enforced TFA setting the user can add a u2f or totp entry by themselves.
1420 # The 'yubico' type requires yubico server settings, which have to be configured on the
1421 # realm, so this is not supported here:
1422 die "domain '$realm' does not support TFA type '$type'\n"
1423 if defined($data) && !$USER_CONTROLLED_TFA_TYPES->{$type};
1426 # Custom TFA entries are stored in priv/tfa.cfg as they can be more complet: u2f uses a
1427 # public key and a key handle, TOTP requires the usual totp settings...
1429 my $tfa_cfg = cfs_read_file
('priv/tfa.cfg');
1430 my $tfa = ($tfa_cfg->{users
}->{$userid} //= {});
1432 if (defined($data)) {
1433 $tfa->{type
} = $type;
1434 $tfa->{data
} = $data;
1435 cfs_write_file
('priv/tfa.cfg', $tfa_cfg);
1437 $user->{keys} = "x!$type";
1439 delete $tfa_cfg->{users
}->{$userid};
1440 cfs_write_file
('priv/tfa.cfg', $tfa_cfg);
1442 delete $user->{keys};
1445 cfs_write_file
('user.cfg', $user_cfg);
1449 my ($username, $realm) = @_;
1451 my $user_cfg = cfs_read_file
('user.cfg');
1452 my $user = $user_cfg->{users
}->{$username}
1453 or die "user '$username' not found\n";
1455 my $keys = $user->{keys};
1458 my $domain_cfg = cfs_read_file
('domains.cfg');
1459 my $realm_cfg = $domain_cfg->{ids
}->{$realm};
1460 die "auth domain '$realm' does not exist\n" if !$realm_cfg;
1462 my $realm_tfa = $realm_cfg->{tfa
};
1463 $realm_tfa = PVE
::Auth
::Plugin
::parse_tfa_config
($realm_tfa)
1466 # new style config starts with an 'x' and optionally contains a !<type> suffix
1467 if ($keys != /^x(?:!.*)?$/) {
1468 # old style config, find the type via the realm
1469 return if !$realm_tfa;
1470 return ($realm_tfa->{type
}, {
1472 config
=> $realm_tfa,
1475 my $tfa_cfg = cfs_read_file
('priv/tfa.cfg');
1476 my $tfa = $tfa_cfg->{users
}->{$username};
1477 return if !$tfa; # should not happen (user.cfg wasn't cleaned up?)
1480 # if the realm has a tfa setting we need to verify the type:
1481 die "auth domain '$realm' and user have mismatching TFA settings\n"
1482 if $realm_tfa && $realm_tfa->{type
} ne $tfa->{type
};
1485 return ($tfa->{type
}, $tfa->{data
});
1489 # bash completion helpers
1491 register_standard_option
('userid-completed',
1492 get_standard_option
('userid', { completion
=> \
&complete_username
}),
1495 sub complete_username
{
1497 my $user_cfg = cfs_read_file
('user.cfg');
1499 return [ keys %{$user_cfg->{users
}} ];
1502 sub complete_group
{
1504 my $user_cfg = cfs_read_file
('user.cfg');
1506 return [ keys %{$user_cfg->{groups
}} ];
1509 sub complete_realm
{
1511 my $domain_cfg = cfs_read_file
('domains.cfg');
1513 return [ keys %{$domain_cfg->{ids
}} ];