1 package PVE
::AccessControl
;
5 use Crypt
::OpenSSL
::Random
;
6 use Crypt
::OpenSSL
::RSA
;
9 use PVE
::Tools
qw(run_command lock_file file_get_contents split_list safe_print);
10 use PVE
::Cluster
qw(cfs_register_file cfs_read_file cfs_write_file cfs_lock_file);
13 use PVE
::Auth
::Plugin
;
19 use Data
::Dumper
; # fixme: remove
21 # load and initialize all plugins
23 PVE
::Auth
::AD-
>register();
24 PVE
::Auth
::LDAP-
>register();
25 PVE
::Auth
::PVE-
>register();
26 PVE
::Auth
::PAM-
>register();
27 PVE
::Auth
::Plugin-
>init();
29 # $authdir must be writable by root only!
30 my $confdir = "/etc/pve";
31 my $authdir = "$confdir/priv";
32 my $authprivkeyfn = "$authdir/authkey.key";
33 my $authpubkeyfn = "$confdir/authkey.pub";
34 my $pve_www_key_fn = "$confdir/pve-www.key";
36 my $ticket_lifetime = 3600*2; # 2 hours
38 Crypt
::OpenSSL
::RSA-
>import_random_seed();
40 cfs_register_file
('user.cfg',
46 PVE
::Auth
::Plugin
::verify_username
(@_);
49 sub pve_verify_realm
{
50 PVE
::Auth
::Plugin
::pve_verify_realm
(@_);
53 sub lock_user_config
{
54 my ($code, $errmsg) = @_;
56 cfs_lock_file
("user.cfg", undef, $code);
58 $errmsg ?
die "$errmsg: $err" : die $err;
65 return $pve_auth_pub_key if $pve_auth_pub_key;
67 my $input = PVE
::Tools
::file_get_contents
($authpubkeyfn);
69 $pve_auth_pub_key = Crypt
::OpenSSL
::RSA-
>new_public_key($input);
71 return $pve_auth_pub_key;
74 my $csrf_prevention_secret;
75 my $get_csrfr_secret = sub {
76 if (!$csrf_prevention_secret) {
77 my $input = PVE
::Tools
::file_get_contents
($pve_www_key_fn);
78 $csrf_prevention_secret = Digest
::SHA
::sha1_base64
($input);
80 return $csrf_prevention_secret;
83 sub assemble_csrf_prevention_token
{
86 my $timestamp = sprintf("%08X", time());
88 my $digest = Digest
::SHA
::sha1_base64
("$timestamp:$username", &$get_csrfr_secret());
90 return "$timestamp:$digest";
93 sub verify_csrf_prevention_token
{
94 my ($username, $token, $noerr) = @_;
96 if ($token =~ m/^([A-Z0-9]{8}):(\S+)$/) {
99 my $ttime = hex($timestamp);
101 my $digest = Digest
::SHA
::sha1_base64
("$timestamp:$username", &$get_csrfr_secret());
103 my $age = time() - $ttime;
104 return if ($digest eq $sig) && ($age > -300) && ($age < $ticket_lifetime);
107 die "Permission denied - invalid csrf token\n" if !$noerr;
112 my $pve_auth_priv_key;
115 return $pve_auth_priv_key if $pve_auth_priv_key;
117 my $input = PVE
::Tools
::file_get_contents
($authprivkeyfn);
119 $pve_auth_priv_key = Crypt
::OpenSSL
::RSA-
>new_private_key($input);
121 return $pve_auth_priv_key;
124 sub assemble_ticket
{
127 my $rsa_priv = get_privkey
();
129 my $timestamp = sprintf("%08X", time());
131 my $plain = "PVE:$username:$timestamp";
133 my $ticket = $plain . "::" . encode_base64
($rsa_priv->sign($plain), '');
139 my ($ticket, $noerr) = @_;
141 if ($ticket && $ticket =~ m/^(PVE:\S+)::([^:\s]+)$/) {
145 my $rsa_pub = get_pubkey
();
146 if ($rsa_pub->verify($plain, decode_base64
($sig))) {
147 if ($plain =~ m/^PVE:(\S+):([A-Z0-9]{8})$/) {
150 my $ttime = hex($timestamp);
152 my $age = time() - $ttime;
154 if (PVE
::Auth
::Plugin
::verify_username
($username, 1) &&
155 ($age > -300) && ($age < $ticket_lifetime)) {
156 return wantarray ?
($username, $age) : $username;
162 die "permission denied - invalid ticket\n" if !$noerr;
168 # - they do not contain the username in plain text
169 # - they are restricted to a specific resource path (example: '/vms/100')
170 sub assemble_vnc_ticket
{
171 my ($username, $path) = @_;
173 my $rsa_priv = get_privkey
();
175 my $timestamp = sprintf("%08X", time());
177 my $plain = "PVEVNC:$timestamp";
179 $path = normalize_path
($path);
181 my $full = "$plain:$username:$path";
183 my $ticket = $plain . "::" . encode_base64
($rsa_priv->sign($full), '');
188 sub verify_vnc_ticket
{
189 my ($ticket, $username, $path, $noerr) = @_;
191 if ($ticket && $ticket =~ m/^(PVEVNC:\S+)::([^:\s]+)$/) {
194 my $full = "$plain:$username:$path";
196 my $rsa_pub = get_pubkey
();
197 # Note: sign only match if $username and $path is correct
198 if ($rsa_pub->verify($full, decode_base64
($sig))) {
199 if ($plain =~ m/^PVEVNC:([A-Z0-9]{8})$/) {
202 my $age = time() - $ttime;
204 if (($age > -20) && ($age < 40)) {
211 die "permission denied - invalid vnc ticket\n" if !$noerr;
216 sub check_user_exist
{
217 my ($usercfg, $username, $noerr) = @_;
219 $username = PVE
::Auth
::Plugin
::verify_username
($username, $noerr);
220 return undef if !$username;
222 return $usercfg->{users
}->{$username} if $usercfg && $usercfg->{users
}->{$username};
224 die "no such user ('$username')\n" if !$noerr;
229 sub check_user_enabled
{
230 my ($usercfg, $username, $noerr) = @_;
232 my $data = check_user_exist
($usercfg, $username, $noerr);
233 return undef if !$data;
235 return 1 if $data->{enable
};
237 return 1 if $username eq 'root@pam'; # root is always enabled
239 die "user '$username' is disabled\n" if !$noerr;
244 # password should be utf8 encoded
245 sub authenticate_user
{
246 my ($username, $password) = @_;
248 die "no username specified\n" if !$username;
252 ($username, $ruid, $realm) = PVE
::Auth
::Plugin
::verify_username
($username);
254 my $usercfg = cfs_read_file
('user.cfg');
256 eval { check_user_enabled
($usercfg, $username); };
263 my $expire = $usercfg->{users
}->{$username}->{expire
};
265 if ($expire && ($expire < $ctime)) {
267 die "account expired\n"
270 my $domain_cfg = cfs_read_file
('domains.cfg');
273 my $cfg = $domain_cfg->{ids
}->{$realm};
274 die "auth domain '$realm' does not exists\n" if !$cfg;
275 my $plugin = PVE
::Auth
::Plugin-
>lookup($cfg->{type
});
276 $plugin->authenticate_user($cfg, $realm, $ruid, $password);
279 sleep(2); # timeout after failed auth
286 sub domain_set_password
{
287 my ($realm, $username, $password) = @_;
289 die "no auth domain specified" if !$realm;
291 my $domain_cfg = cfs_read_file
('domains.cfg');
293 my $cfg = $domain_cfg->{ids
}->{$realm};
294 die "auth domain '$realm' does not exists\n" if !$cfg;
295 my $plugin = PVE
::Auth
::Plugin-
>lookup($cfg->{type
});
296 $plugin->store_password($cfg, $realm, $username, $password);
301 my ($username, $usercfg, $group) = @_;
302 $usercfg->{users
}->{$username}->{groups
}->{$group} = 1;
303 $usercfg->{groups
}->{$group}->{users
}->{$username} = 1;
306 sub delete_user_group
{
308 my ($username, $usercfg) = @_;
310 foreach my $group (keys %{$usercfg->{groups
}}) {
312 delete ($usercfg->{groups
}->{$group}->{users
}->{$username})
313 if $usercfg->{groups
}->{$group}->{users
}->{$username};
317 sub delete_user_acl
{
319 my ($username, $usercfg) = @_;
321 foreach my $acl (keys %{$usercfg->{acl
}}) {
323 delete ($usercfg->{acl
}->{$acl}->{users
}->{$username})
324 if $usercfg->{acl
}->{$acl}->{users
}->{$username};
328 sub delete_group_acl
{
330 my ($group, $usercfg) = @_;
332 foreach my $acl (keys %{$usercfg->{acl
}}) {
334 delete ($usercfg->{acl
}->{$acl}->{groups
}->{$group})
335 if $usercfg->{acl
}->{$acl}->{groups
}->{$group};
339 sub delete_pool_acl
{
341 my ($pool, $usercfg) = @_;
343 my $path = "/pool/$pool";
345 foreach my $aclpath (keys %{$usercfg->{acl
}}) {
346 delete ($usercfg->{acl
}->{$aclpath})
347 if $usercfg->{acl
}->{$aclpath} eq 'path';
351 # we automatically create some predefined roles by splitting privs
352 # into 3 groups (per category)
353 # root: only root is allowed to do that
354 # admin: an administrator can to that
355 # user: a normak user/customer can to that
365 'VM.Config.Options', # covers all other things
372 'VM.Config.CDROM', # change CDROM media
384 'Sys.Modify', # edit/change node settings
387 'Permissions.Modify',
399 'Datastore.Allocate',
400 'Datastore.AllocateTemplate',
403 'Datastore.AllocateSpace',
415 'Group.Allocate', # edit/change group settings
416 'Realm.AllocateUser',
424 'Pool.Allocate', # create/delete pools
431 my $valid_privs = {};
433 my $special_roles = {
434 'NoAccess' => {}, # no priviledges
435 'Administrator' => $valid_privs, # all priviledges
440 foreach my $cat (keys %$privgroups) {
441 my $cd = $privgroups->{$cat};
442 foreach my $p (@{$cd->{root
}}, @{$cd->{admin
}},
443 @{$cd->{user
}}, @{$cd->{audit
}}) {
444 $valid_privs->{$p} = 1;
446 foreach my $p (@{$cd->{admin
}}, @{$cd->{user
}}, @{$cd->{audit
}}) {
448 $special_roles->{"PVE${cat}Admin"}->{$p} = 1;
449 $special_roles->{"PVEAdmin"}->{$p} = 1;
451 if (scalar(@{$cd->{user
}})) {
452 foreach my $p (@{$cd->{user
}}, @{$cd->{audit
}}) {
453 $special_roles->{"PVE${cat}User"}->{$p} = 1;
456 foreach my $p (@{$cd->{audit
}}) {
457 $special_roles->{"PVEAuditor"}->{$p} = 1;
465 my ($role, $usercfg, $privs) = @_;
469 die "role '$role' does not exist\n" if !$usercfg->{roles
}->{$role};
471 foreach my $priv (split_list
($privs)) {
472 if (defined ($valid_privs->{$priv})) {
473 $usercfg->{roles
}->{$role}->{$priv} = 1;
475 die "invalid priviledge '$priv'\n";
487 $path = '/' if !$path;
489 $path = "/$path" if $path !~ m
|^/|;
491 return undef if $path !~ m
|^[[:alnum
:]\
-\_\
/]+$|;
497 PVE
::JSONSchema
::register_format
('pve-groupid', \
&verify_groupname
);
498 sub verify_groupname
{
499 my ($groupname, $noerr) = @_;
501 if ($groupname !~ m/^[A-Za-z0-9\.\-_]+$/) {
503 die "group name '$groupname' contains invalid characters\n" if !$noerr;
511 PVE
::JSONSchema
::register_format
('pve-roleid', \
&verify_rolename
);
512 sub verify_rolename
{
513 my ($rolename, $noerr) = @_;
515 if ($rolename !~ m/^[A-Za-z0-9\.\-_]+$/) {
517 die "role name '$rolename' contains invalid characters\n" if !$noerr;
525 PVE
::JSONSchema
::register_format
('pve-poolid', \
&verify_groupname
);
526 sub verify_poolname
{
527 my ($poolname, $noerr) = @_;
529 if ($poolname !~ m/^[A-Za-z0-9\.\-_]+$/) {
531 die "pool name '$poolname' contains invalid characters\n" if !$noerr;
539 PVE
::JSONSchema
::register_format
('pve-priv', \
&verify_privname
);
540 sub verify_privname
{
541 my ($priv, $noerr) = @_;
543 if (!$valid_privs->{$priv}) {
544 die "invalid priviledge '$priv'\n" if !$noerr;
552 sub userconfig_force_defaults
{
555 foreach my $r (keys %$special_roles) {
556 $cfg->{roles
}->{$r} = $special_roles->{$r};
559 # fixme: remove 'root' group (not required)?
562 $cfg->{users
}->{'root@pam'}->{enable
} = 1;
565 sub parse_user_config
{
566 my ($filename, $raw) = @_;
570 userconfig_force_defaults
($cfg);
572 while ($raw && $raw =~ s/^(.*?)(\n|$)//) {
575 next if $line =~ m/^\s*$/; # skip empty lines
579 foreach my $d (split (/:/, $line)) {
585 my $et = shift @data;
588 my ($user, $enable, $expire, $firstname, $lastname, $email, $comment) = @data;
590 my (undef, undef, $realm) = PVE
::Auth
::Plugin
::verify_username
($user, 1);
592 warn "user config - ignore user '$user' - invalid user name\n";
596 $enable = $enable ?
1 : 0;
598 $expire = 0 if !$expire;
600 if ($expire !~ m/^\d+$/) {
601 warn "user config - ignore user '$user' - (illegal characters in expire '$expire')\n";
604 $expire = int($expire);
606 #if (!verify_groupname ($group, 1)) {
607 # warn "user config - ignore user '$user' - invalid characters in group name\n";
611 $cfg->{users
}->{$user} = {
615 $cfg->{users
}->{$user}->{firstname
} = PVE
::Tools
::decode_text
($firstname) if $firstname;
616 $cfg->{users
}->{$user}->{lastname
} = PVE
::Tools
::decode_text
($lastname) if $lastname;
617 $cfg->{users
}->{$user}->{email
} = $email;
618 $cfg->{users
}->{$user}->{comment
} = PVE
::Tools
::decode_text
($comment) if $comment;
619 $cfg->{users
}->{$user}->{expire
} = $expire;
621 #$cfg->{users}->{$user}->{groups}->{$group} = 1;
622 #$cfg->{groups}->{$group}->{$user} = 1;
624 } elsif ($et eq 'group') {
625 my ($group, $userlist, $comment) = @data;
627 if (!verify_groupname
($group, 1)) {
628 warn "user config - ignore group '$group' - invalid characters in group name\n";
632 # make sure to add the group (even if there are no members)
633 $cfg->{groups
}->{$group} = { users
=> {} } if !$cfg->{groups
}->{$group};
635 $cfg->{groups
}->{$group}->{comment
} = PVE
::Tools
::decode_text
($comment) if $comment;
637 foreach my $user (split_list
($userlist)) {
639 if (!PVE
::Auth
::Plugin
::verify_username
($user, 1)) {
640 warn "user config - ignore invalid group member '$user'\n";
644 if ($cfg->{users
}->{$user}) { # user exists
645 $cfg->{users
}->{$user}->{groups
}->{$group} = 1;
646 $cfg->{groups
}->{$group}->{users
}->{$user} = 1;
648 warn "user config - ignore invalid group member '$user'\n";
652 } elsif ($et eq 'role') {
653 my ($role, $privlist) = @data;
655 if (!verify_rolename
($role, 1)) {
656 warn "user config - ignore role '$role' - invalid characters in role name\n";
660 # make sure to add the role (even if there are no privileges)
661 $cfg->{roles
}->{$role} = {} if !$cfg->{roles
}->{$role};
663 foreach my $priv (split_list
($privlist)) {
664 if (defined ($valid_privs->{$priv})) {
665 $cfg->{roles
}->{$role}->{$priv} = 1;
667 warn "user config - ignore invalid priviledge '$priv'\n";
671 } elsif ($et eq 'acl') {
672 my ($propagate, $pathtxt, $uglist, $rolelist) = @data;
674 if (my $path = normalize_path
($pathtxt)) {
675 foreach my $role (split_list
($rolelist)) {
677 if (!verify_rolename
($role, 1)) {
678 warn "user config - ignore invalid role name '$role' in acl\n";
682 foreach my $ug (split_list
($uglist)) {
683 if ($ug =~ m/^@(\S+)$/) {
685 if ($cfg->{groups
}->{$group}) { # group exists
686 $cfg->{acl
}->{$path}->{groups
}->{$group}->{$role} = $propagate;
688 warn "user config - ignore invalid acl group '$group'\n";
690 } elsif (PVE
::Auth
::Plugin
::verify_username
($ug, 1)) {
691 if ($cfg->{users
}->{$ug}) { # user exists
692 $cfg->{acl
}->{$path}->{users
}->{$ug}->{$role} = $propagate;
694 warn "user config - ignore invalid acl member '$ug'\n";
697 warn "user config - invalid user/group '$ug' in acl\n";
702 warn "user config - ignore invalid path in acl '$pathtxt'\n";
704 } elsif ($et eq 'pool') {
705 my ($pool, $comment, $vmlist, $storelist) = @data;
707 if (!verify_poolname
($pool, 1)) {
708 warn "user config - ignore pool '$pool' - invalid characters in pool name\n";
712 # make sure to add the pool (even if there are no members)
713 $cfg->{pools
}->{$pool} = { vms
=> {}, storage
=> {} } if !$cfg->{pools
}->{$pool};
715 $cfg->{pools
}->{$pool}->{comment
} = PVE
::Tools
::decode_text
($comment) if $comment;
717 foreach my $vmid (split_list
($vmlist)) {
718 if ($vmid !~ m/^\d+$/) {
719 warn "user config - ignore invalid vmid '$vmid' in pool '$pool'\n";
724 if ($cfg->{vms
}->{$vmid}) {
725 warn "user config - ignore duplicate vmid '$vmid' in pool '$pool'\n";
729 $cfg->{pools
}->{$pool}->{vms
}->{$vmid} = 1;
731 # record vmid ==> pool relation
732 $cfg->{vms
}->{$vmid} = $pool;
735 foreach my $storeid (split_list
($storelist)) {
736 if ($storeid !~ m/^[a-z][a-z0-9\-\_\.]*[a-z0-9]$/i) {
737 warn "user config - ignore invalid storage '$storeid' in pool '$pool'\n";
740 $cfg->{pools
}->{$pool}->{storage
}->{$storeid} = 1;
743 warn "user config - ignore config line: $line\n";
747 userconfig_force_defaults
($cfg);
752 sub write_user_config
{
753 my ($filename, $cfg) = @_;
757 foreach my $user (keys %{$cfg->{users
}}) {
758 my $d = $cfg->{users
}->{$user};
759 my $firstname = $d->{firstname
} ? PVE
::Tools
::encode_text
($d->{firstname
}) : '';
760 my $lastname = $d->{lastname
} ? PVE
::Tools
::encode_text
($d->{lastname
}) : '';
761 my $email = $d->{email
} || '';
762 my $comment = $d->{comment
} ? PVE
::Tools
::encode_text
($d->{comment
}) : '';
763 my $expire = int($d->{expire
} || 0);
764 my $enable = $d->{enable
} ?
1 : 0;
765 $data .= "user:$user:$enable:$expire:$firstname:$lastname:$email:$comment:\n";
770 foreach my $group (keys %{$cfg->{groups
}}) {
771 my $d = $cfg->{groups
}->{$group};
772 my $list = join (',', keys %{$d->{users
}});
773 my $comment = $d->{comment
} ? PVE
::Tools
::encode_text
($d->{comment
}) : '';
774 $data .= "group:$group:$list:$comment:\n";
779 foreach my $pool (keys %{$cfg->{pools
}}) {
780 my $d = $cfg->{pools
}->{$pool};
781 my $vmlist = join (',', keys %{$d->{vms
}});
782 my $storelist = join (',', keys %{$d->{storage
}});
783 my $comment = $d->{comment
} ? PVE
::Tools
::encode_text
($d->{comment
}) : '';
784 $data .= "pool:$pool:$comment:$vmlist:$storelist:\n";
789 foreach my $role (keys %{$cfg->{roles
}}) {
790 next if $special_roles->{$role};
792 my $d = $cfg->{roles
}->{$role};
793 my $list = join (',', keys %$d);
794 $data .= "role:$role:$list:\n";
799 foreach my $path (sort keys %{$cfg->{acl
}}) {
800 my $d = $cfg->{acl
}->{$path};
804 foreach my $group (keys %{$d->{groups
}}) {
807 foreach my $role (sort keys %{$d->{groups
}->{$group}}) {
808 my $propagate = $d->{groups
}->{$group}->{$role};
817 $ra->{0}->{$l0}->{"\@$group"} = 1 if $l0;
818 $ra->{1}->{$l1}->{"\@$group"} = 1 if $l1;
821 foreach my $user (keys %{$d->{users
}}) {
822 # no need to save, because root is always 'Administartor'
823 next if $user eq 'root@pam';
827 foreach my $role (sort keys %{$d->{users
}->{$user}}) {
828 my $propagate = $d->{users
}->{$user}->{$role};
837 $ra->{0}->{$l0}->{$user} = 1 if $l0;
838 $ra->{1}->{$l1}->{$user} = 1 if $l1;
841 foreach my $rolelist (sort keys %{$ra->{0}}) {
842 my $uglist = join (',', keys %{$ra->{0}->{$rolelist}});
843 $data .= "acl:0:$path:$uglist:$rolelist:\n";
845 foreach my $rolelist (sort keys %{$ra->{1}}) {
846 my $uglist = join (',', keys %{$ra->{1}->{$rolelist}});
847 $data .= "acl:1:$path:$uglist:$rolelist:\n";
855 my ($cfg, $user, $path) = @_;
857 # NOTE: we do not consider pools here.
858 # You need to use $rpcenv->roles() instead if you want that.
860 return 'Administrator' if $user eq 'root@pam'; # root can do anything
864 foreach my $p (sort keys %{$cfg->{acl
}}) {
865 my $final = ($path eq $p);
867 next if !(($p eq '/') || $final || ($path =~ m
|^$p/|));
869 my $acl = $cfg->{acl
}->{$p};
871 #print "CHECKACL $path $p\n";
872 #print "ACL $path = " . Dumper ($acl);
874 if (my $ri = $acl->{users
}->{$user}) {
876 foreach my $role (keys %$ri) {
877 my $propagate = $ri->{$role};
878 if ($final || $propagate) {
879 #print "APPLY ROLE $p $user $role\n";
885 $perm = $new; # overwrite previous settings
886 next; # user privs always override group privs
891 foreach my $g (keys %{$acl->{groups
}}) {
892 next if !$cfg->{groups
}->{$g}->{users
}->{$user};
893 if (my $ri = $acl->{groups
}->{$g}) {
894 foreach my $role (keys %$ri) {
895 my $propagate = $ri->{$role};
896 if ($final || $propagate) {
897 #print "APPLY ROLE $p \@$g $role\n";
905 $perm = $new; # overwrite previous settings
910 return ('NoAccess') if defined ($perm->{NoAccess
});
911 #return () if defined ($perm->{NoAccess});
913 #print "permission $user $path = " . Dumper ($perm);
915 my @ra = keys %$perm;
917 #print "roles $user $path = " . join (',', @ra) . "\n";
923 my ($cfg, $user, $path) = @_;
925 $user = PVE
::Auth
::Plugin
::verify_username
($user, 1);
928 my @ra = roles
($cfg, $user, $path);
932 foreach my $role (@ra) {
933 if (my $privset = $cfg->{roles
}->{$role}) {
934 foreach my $p (keys %$privset) {
940 #print "priviledges $user $path = " . Dumper ($privs);
945 sub check_permissions
{
946 my ($username, $path, $privlist) = @_;
948 $path = normalize_path
($path);
949 my $usercfg = cfs_read_file
('user.cfg');
950 my $perm = permission
($usercfg, $username, $path);
952 foreach my $priv (split_list
($privlist)) {
953 return undef if !$perm->{$priv};