]>
git.proxmox.com Git - pve-access-control.git/blob - PVE/RPCEnvironment.pm
1 package PVE
::RPCEnvironment
;
5 use POSIX
qw(:sys_wait_h EINTR);
10 use PVE
::Exception
qw(raise raise_perm_exc);
16 use PVE
::AccessControl
;
19 # we use this singleton class to pass RPC related environment values
23 # save $SIG{CHLD} handler implementation.
24 # simply set $SIG{CHLD} = $worker_reaper;
25 # and register forked processes with &$register_worker(pid)
26 # Note: using $SIG{CHLD} = 'IGNORE' or $SIG{CHLD} = sub { wait (); } or ...
27 # has serious side effects, because perls built in system() and open()
28 # functions can't get the correct exit status of a child. So we cant use
29 # that (also see perlipc)
33 my $log_task_result = sub {
34 my ($upid, $user, $status) = @_;
36 my $msg = 'successful';
39 my $ec = $status >> 8;
40 my $ic = $status & 255;
41 $msg = $ec ?
"failed ($ec)" : "interrupted ($ic)";
44 my $tlist = active_workers
($upid);
45 PVE
::Cluster
::broadcast_tasklist
($tlist);
47 foreach my $t (@$tlist) {
48 if ($t->{upid
} eq $upid) {
53 if ($task && $task->{status
}) {
54 $msg = $task->{status
};
56 PVE
::Cluster
::log_msg
($pri, $user, "end task $upid $msg");
59 my $worker_reaper = sub {
61 foreach my $pid (keys %$WORKER_PIDS) {
62 my $waitpid = waitpid ($pid, WNOHANG
);
63 if (defined($waitpid) && ($waitpid == $pid)) {
64 my $info = $WORKER_PIDS->{$pid};
65 if ($info && $info->{upid
} && $info->{user
}) {
66 &$log_task_result($info->{upid
}, $info->{user
}, $?);
68 delete ($WORKER_PIDS->{$pid});
73 my $register_worker = sub {
74 my ($pid, $user, $upid) = @_;
78 # do not register if already finished
79 my $waitpid = waitpid ($pid, WNOHANG
);
80 if (defined($waitpid) && ($waitpid == $pid)) {
81 delete ($WORKER_PIDS->{$pid});
85 $WORKER_PIDS->{$pid} = {
93 my $compile_acl_path = sub {
94 my ($self, $user, $path) = @_;
96 my $cfg = $self->{user_cfg
};
98 return undef if !$cfg->{roles
};
100 die "internal error" if $user eq 'root@pam';
102 my $cache = $self->{aclcache
};
103 $cache->{$user} = {} if !$cache->{$user};
104 my $data = $cache->{$user};
106 if (!$data->{poolroles
}) {
107 $data->{poolroles
} = {};
109 foreach my $pool (keys %{$cfg->{pools
}}) {
110 my $d = $cfg->{pools
}->{$pool};
111 my @ra = PVE
::AccessControl
::roles
($cfg, $user, "/pool/$pool"); # pool roles
112 next if !scalar(@ra);
113 foreach my $vmid (keys %{$d->{vms
}}) {
115 $data->{poolroles
}->{"/vms/$vmid"}->{$role} = 1;
118 foreach my $storeid (keys %{$d->{storage
}}) {
120 $data->{poolroles
}->{"/storage/$storeid"}->{$role} = 1;
126 my @ra = PVE
::AccessControl
::roles
($cfg, $user, $path);
128 # apply roles inherited from pools
129 # Note: assume we do not want to propagate those privs
130 if ($data->{poolroles
}->{$path}) {
131 if (!($ra[0] && $ra[0] eq 'NoAccess')) {
132 if ($data->{poolroles
}->{$path}->{NoAccess
}) {
135 foreach my $role (keys %{$data->{poolroles
}->{$path}}) {
142 $data->{roles
}->{$path} = [ @ra ];
145 foreach my $role (@ra) {
146 if (my $privset = $cfg->{roles
}->{$role}) {
147 foreach my $p (keys %$privset) {
152 $data->{privs
}->{$path} = $privs;
158 my ($self, $user, $path) = @_;
160 if ($user eq 'root@pam') { # root can do anything
161 return ('Administrator');
164 $user = PVE
::AccessControl
::verify_username
($user, 1);
167 my $cache = $self->{aclcache
};
168 $cache->{$user} = {} if !$cache->{$user};
170 my $acl = $cache->{$user};
172 my $roles = $acl->{roles
}->{$path};
173 return @$roles if $roles;
175 &$compile_acl_path($self, $user, $path);
176 $roles = $acl->{roles
}->{$path} || [];
181 my ($self, $user, $path) = @_;
183 if ($user eq 'root@pam') { # root can do anything
184 my $cfg = $self->{user_cfg
};
185 return $cfg->{roles
}->{'Administrator'};
188 $user = PVE
::AccessControl
::verify_username
($user, 1);
191 my $cache = $self->{aclcache
};
192 $cache->{$user} = {} if !$cache->{$user};
194 my $acl = $cache->{$user};
196 my $perm = $acl->{privs
}->{$path};
197 return $perm if $perm;
199 return &$compile_acl_path($self, $user, $path);
203 my ($self, $user, $path, $privs, $noerr) = @_;
205 my $perm = $self->permissions($user, $path);
207 foreach my $priv (@$privs) {
208 PVE
::AccessControl
::verify_privname
($priv);
209 if (!$perm->{$priv}) {
210 return undef if $noerr;
211 raise_perm_exc
("$path, $priv");
219 my ($self, $user, $path, $privs, $noerr) = @_;
221 my $perm = $self->permissions($user, $path);
224 foreach my $priv (@$privs) {
225 PVE
::AccessControl
::verify_privname
($priv);
226 if ($perm->{$priv}) {
234 return undef if $noerr;
236 raise_perm_exc
("$path, " . join("|", @$privs));
240 my ($self, $username, $path, $privs, $any, $noerr) = @_;
242 return $self->check_any($username, $path, $privs, $noerr);
244 return $self->check($username, $path, $privs, $noerr);
248 sub check_user_enabled
{
249 my ($self, $user, $noerr) = @_;
251 my $cfg = $self->{user_cfg
};
252 return PVE
::AccessControl
::check_user_enabled
($cfg, $user, $noerr);
255 sub check_user_exist
{
256 my ($self, $user, $noerr) = @_;
258 my $cfg = $self->{user_cfg
};
259 return PVE
::AccessControl
::check_user_exist
($cfg, $user, $noerr);
262 sub check_pool_exist
{
263 my ($self, $pool, $noerr) = @_;
265 my $cfg = $self->{user_cfg
};
267 return 1 if $cfg->{pools
}->{$pool};
269 return undef if $noerr;
271 raise_perm_exc
("pool '$pool' does not exist");
275 my ($self, $user, $vmid, $pool, $privs, $any, $noerr) = @_;
277 my $cfg = $self->{user_cfg
};
280 return if $self->check_full($user, "/pool/$pool", $privs, $any, 1);
282 return $self->check_full($user, "/vms/$vmid", $privs, $any, $noerr);
285 sub check_volume_access
{
286 my ($self, $user, $storecfg, $vmid, $volid) = @_;
288 # test if we have read access to volid
291 my ($sid, $volname) = PVE
::Storage
::parse_volume_id
($volid, 1);
293 my ($ownervm, $vtype);
294 ($path, $ownervm, $vtype) = PVE
::Storage
::path
($storecfg, $volid);
295 if ($vtype eq 'iso' || $vtype eq 'vztmpl') {
296 # we simply allow access
297 } elsif (defined($ownervm) && defined($vmid) && ($ownervm == $vmid)) {
298 # we are owner - allow access
299 } elsif ($vtype eq 'backup' && $ownervm) {
300 $self->check($user, "/storage/$sid", ['Datastore.AllocateSpace']);
301 $self->check($user, "/vms/$ownervm", ['VM.Backup']);
303 # allow if we are Datastore administrator
304 $self->check($user, "/storage/$sid", ['Datastore.Allocate']);
307 die "Only root can pass arbitrary filesystem paths."
308 if $user ne 'root@pam';
310 $path = abs_path
($volid);
311 if ($path =~ m
|^(/.+)$|) {
312 $path = $1; # untaint any path
318 sub is_group_member
{
319 my ($self, $group, $user) = @_;
321 my $cfg = $self->{user_cfg
};
323 return 0 if !$cfg->{groups
}->{$group};
325 return defined($cfg->{groups
}->{$group}->{users
}->{$user});
329 my ($self, $user, $privs, $any) = @_;
331 my $cfg = $self->{user_cfg
};
334 foreach my $group (keys %{$cfg->{groups
}}) {
335 my $path = "/access/groups/$group";
336 if ($self->check_full($user, $path, $privs, $any, 1)) {
337 $groups->{$group} = $cfg->{groups
}->{$group};
344 sub group_member_join
{
345 my ($self, $grouplist) = @_;
349 my $cfg = $self->{user_cfg
};
350 foreach my $group (@$grouplist) {
351 my $data = $cfg->{groups
}->{$group};
353 foreach my $user (keys %{$data->{users
}}) {
361 sub check_perm_modify
{
362 my ($self, $username, $path, $noerr) = @_;
364 return $self->check($username, '/access', [ 'Permissions.Modify' ], $noerr) if !$path;
366 my $testperms = [ 'Permissions.Modify' ];
367 if ($path =~ m
|^/storage/.+$|) {
368 push @$testperms, 'Datastore.Allocate';
369 } elsif ($path =~ m
|^/vms/.+$|) {
370 push @$testperms, 'VM.Allocate';
371 } elsif ($path =~ m
|^/pool/.+$|) {
372 push @$testperms, 'Pool.Allocate';
375 return $self->check_any($username, $path, $testperms, $noerr);
378 sub exec_api2_perm_check
{
379 my ($self, $check, $username, $param, $noerr) = @_;
381 # syslog("info", "CHECK " . join(', ', @$check));
384 my $test = $check->[$ind++];
385 die "no permission test specified" if !$test;
387 if ($test eq 'and') {
388 while (my $subcheck = $check->[$ind++]) {
389 $self->exec_api2_perm_check($subcheck, $username, $param);
392 } elsif ($test eq 'or') {
393 while (my $subcheck = $check->[$ind++]) {
394 return 1 if $self->exec_api2_perm_check($subcheck, $username, $param, 1);
398 } elsif ($test eq 'perm') {
399 my ($t, $tmplpath, $privs, %options) = @$check;
400 my $any = $options{any
};
401 die "missing parameters" if !($tmplpath && $privs);
402 my $require_param = $options{require_param
};
403 if ($require_param && !defined($param->{$require_param})) {
407 my $path = PVE
::Tools
::template_replace
($tmplpath, $param);
408 $path = PVE
::AccessControl
::normalize_path
($path);
409 return $self->check_full($username, $path, $privs, $any, $noerr);
410 } elsif ($test eq 'userid-group') {
411 my $userid = $param->{userid
};
412 my ($t, $privs, %options) = @$check;
413 return 0 if !$options{groups_param
} && !$self->check_user_exist($userid, $noerr);
414 if (!$self->check_any($username, "/access/groups", $privs, 1)) {
415 my $groups = $self->filter_groups($username, $privs, 1);
416 if ($options{groups_param
}) {
417 my @group_param = PVE
::Tools
::split_list
($param->{groups
});
418 raise_perm_exc
("/access/groups, " . join("|", @$privs)) if !scalar(@group_param);
419 foreach my $pg (@group_param) {
420 raise_perm_exc
("/access/groups/$pg, " . join("|", @$privs))
424 my $allowed_users = $self->group_member_join([keys %$groups]);
425 if (!$allowed_users->{$userid}) {
432 } elsif ($test eq 'userid-param') {
433 my ($userid, undef, $realm) = PVE
::AccessControl
::verify_username
($param->{userid
});
434 my ($t, $subtest) = @$check;
435 die "missing parameters" if !$subtest;
436 if ($subtest eq 'self') {
437 return 0 if !$self->check_user_exist($userid, $noerr);
438 return 1 if $username eq $userid;
441 } elsif ($subtest eq 'Realm.AllocateUser') {
442 my $path = "/access/realm/$realm";
443 return $self->check($username, $path, ['Realm.AllocateUser'], $noerr);
445 die "unknown userid-param test";
447 } elsif ($test eq 'perm-modify') {
448 my ($t, $tmplpath) = @$check;
449 my $path = PVE
::Tools
::template_replace
($tmplpath, $param);
450 $path = PVE
::AccessControl
::normalize_path
($path);
451 return $self->check_perm_modify($username, $path, $noerr);
453 die "unknown permission test";
457 sub check_api2_permissions
{
458 my ($self, $perm, $username, $param) = @_;
460 return 1 if !$username && $perm->{user
} eq 'world';
462 raise_perm_exc
("user != null") if !$username;
464 return 1 if $username eq 'root@pam';
466 raise_perm_exc
('user != root@pam') if !$perm;
468 return 1 if $perm->{user
} && $perm->{user
} eq 'all';
470 return $self->exec_api2_perm_check($perm->{check
}, $username, $param)
476 # initialize environment - must be called once at program startup
478 my ($class, $type, %params) = @_;
480 $class = ref($class) || $class;
482 die "already initialized" if $pve_env;
484 die "unknown environment type" if !$type || $type !~ m/^(cli|pub|priv|ha)$/;
486 $SIG{CHLD
} = $worker_reaper;
489 # cli ... command started fron command line
490 # pub ... access from public server (apache)
491 # priv ... access from private server (pvedaemon)
492 # ha ... access from HA resource manager agent (rgmanager)
503 foreach my $p (keys %params) {
504 if ($p eq 'atfork') {
505 $self->{$p} = $params{$p};
507 die "unknown option '$p'";
513 my ($sysname, $nodename) = POSIX
::uname
();
515 $nodename =~ s/\..*$//; # strip domain part, if any
517 $self->{nodename
} = $nodename;
525 die "not initialized" if !$pve_env;
530 # init_request - must be called before each RPC request
532 my ($self, %params) = @_;
534 PVE
::Cluster
::cfs_update
();
536 $self->{result_attributes
} = {};
538 my $userconfig; # we use this for regression tests
539 foreach my $p (keys %params) {
540 if ($p eq 'userconfig') {
541 $userconfig = $params{$p};
543 die "unknown parameter '$p'";
548 $self->{aclcache
} = {};
550 my $ucdata = PVE
::Tools
::file_get_contents
($userconfig);
551 my $cfg = PVE
::AccessControl
::parse_user_config
($userconfig, $ucdata);
552 $self->{user_cfg
} = $cfg;
555 my $ucvers = PVE
::Cluster
::cfs_file_version
('user.cfg');
556 if (!$self->{aclcache
} || !defined($self->{aclversion
}) ||
557 !defined($ucvers) || ($ucvers ne $self->{aclversion
})) {
558 $self->{aclversion
} = $ucvers;
559 my $cfg = PVE
::Cluster
::cfs_read_file
('user.cfg');
560 $self->{user_cfg
} = $cfg;
565 $self->{user_cfg
} = {};
566 die "Unable to load access control list: $err";
571 my ($self, $ip) = @_;
573 $self->{client_ip
} = $ip;
579 return $self->{client_ip
};
582 sub set_result_attrib
{
583 my ($self, $key, $value) = @_;
585 $self->{result_attributes
}->{$key} = $value;
588 sub get_result_attrib
{
589 my ($self, $key) = @_;
591 return $self->{result_attributes
}->{$key};
595 my ($self, $lang) = @_;
597 # fixme: initialize I18N
599 $self->{language
} = $lang;
605 return $self->{language
};
609 my ($self, $user) = @_;
613 $self->{user
} = $user;
619 die "user name not set\n" if !$self->{user
};
621 return $self->{user
};
624 # read/update list of active workers
625 # we move all finished tasks to the archive index,
626 # but keep aktive and most recent task in the active file.
627 # $nocheck ... consider $new_upid still running (avoid that
628 # we try to read the reult to early.
630 my ($new_upid, $nocheck) = @_;
632 my $lkfn = "/var/log/pve/tasks/.active.lock";
638 my $tasklist = PVE
::INotify
::read_file
('active');
642 my $thash = {}; # only list task once
644 my $check_task = sub {
645 my ($task, $running) = @_;
647 if ($running || PVE
::ProcFSTools
::check_process_running
($task->{pid
}, $task->{pstart
})) {
653 delete $task->{pstart
};
656 foreach my $task (@$tasklist) {
657 my $upid = $task->{upid
};
658 next if $thash->{$upid};
659 $thash->{$upid} = $task;
663 if ($new_upid && !(my $task = $thash->{$new_upid})) {
664 $task = PVE
::Tools
::upid_decode
($new_upid);
665 $task->{upid
} = $new_upid;
666 $thash->{$new_upid} = $task;
667 &$check_task($task, $nocheck);
671 @ta = sort { $b->{starttime
} cmp $a->{starttime
} } @ta;
673 my $save = defined($new_upid);
675 foreach my $task (@ta) {
676 next if $task->{endtime
};
677 $task->{endtime
} = time();
678 $task->{status
} = PVE
::Tools
::upid_read_status
($task->{upid
});
684 foreach my $task (@ta) {
685 if (!$task->{saved
}) {
686 $archive .= sprintf("$task->{upid} %08X $task->{status}\n", $task->{endtime
});
695 my $filename = "/var/log/pve/tasks/index";
697 my $fh = IO
::File-
>new($filename, '>>', 0644) ||
698 die "unable to open file '$filename' - $!\n";
699 PVE
::Tools
::safe_print
($filename, $fh, $archive);
702 die "unable to close file '$filename' - $!\n";
707 foreach my $task (@arlist) { # mark as not saved
711 my $maxsize = 50000; # about 1000 entries
712 if ($size > $maxsize) {
713 rename($filename, "$filename.1");
717 # we try to reduce the amount of data
718 # list all running tasks and task and a few others
719 # try to limit to 25 tasks
721 my $max = 25 - scalar(@$tlist);
722 foreach my $task (@ta) {
728 PVE
::INotify
::write_file
('active', $tlist) if $save;
733 my $res = PVE
::Tools
::lock_file
($lkfn, $timeout, $code);
739 my $kill_process_group = sub {
740 my ($pid, $pstart) = @_;
742 # send kill to process group (negative pid)
745 # always send signal to all pgrp members
746 kill(15, $kpid); # send TERM signal
748 # give max 5 seconds to shut down
749 for (my $i = 0; $i < 5; $i++) {
750 return if !PVE
::ProcFSTools
::check_process_running
($pid, $pstart);
759 my ($upid, $killit) = @_;
761 my $task = PVE
::Tools
::upid_decode
($upid);
763 my $running = PVE
::ProcFSTools
::check_process_running
($task->{pid
}, $task->{pstart
});
765 return 0 if !$running;
768 &$kill_process_group($task->{pid
});
775 # start long running workers
776 # STDIN is redirected to /dev/null
777 # STDOUT,STDERR are redirected to the filename returned by upid_decode
778 # NOTE: we simulate running in foreground if ($self->{type} eq 'cli')
780 my ($self, $dtype, $id, $user, $function, $background) = @_;
782 $dtype = 'unknown' if !defined ($dtype);
783 $id = '' if !defined ($id);
785 $user = 'root@pve' if !defined ($user);
787 my $sync = ($self->{type
} eq 'cli' && !$background) ?
1 : 0;
792 local $SIG{TERM
} = 'IGNORE';
794 my $starttime = time ();
796 my @psync = POSIX
::pipe();
797 my @csync = POSIX
::pipe();
799 my $node = $self->{nodename
};
802 die "unable to fork worker - $!" if !defined($cpid);
804 my $workerpuid = $cpid ?
$cpid : $$;
806 my $pstart = PVE
::ProcFSTools
::read_proc_starttime
($workerpuid) ||
807 die "unable to read process start time";
809 my $upid = PVE
::Tools
::upid_encode
({
810 node
=> $node, pid
=> $workerpuid, pstart
=> $pstart,
811 starttime
=> $starttime, type
=> $dtype, id
=> $id, user
=> $user });
815 if (!$cpid) { # child
819 $SIG{INT
} = $SIG{QUIT
} = $SIG{TERM
} = sub { die "received interrupt\n"; };
821 $SIG{CHLD
} = $SIG{PIPE
} = 'DEFAULT';
823 # set sess/process group - we want to be able to kill the
824 # whole process group
827 POSIX
::close ($psync[0]);
828 POSIX
::close ($csync[1]);
830 $outfh = $sync ?
$psync[1] : undef;
833 PVE
::INotify
::inotify_close
();
835 if (my $atfork = $self->{atfork
}) {
839 # same algorythm as used inside SA
841 my $fd = fileno (STDIN
);
845 POSIX
::close(0) if $fd != 0;
847 die "unable to redirect STDIN - $!"
848 if !open(STDIN
, "</dev/null");
850 $outfh = PVE
::Tools
::upid_open
($upid);
855 $fd = fileno(STDOUT
);
857 POSIX
::close (1) if $fd != 1;
859 die "unable to redirect STDOUT - $!"
860 if !open(STDOUT
, ">&", $outfh);
862 STDOUT-
>autoflush (1);
864 # redirect STDERR to STDOUT
865 $fd = fileno (STDERR
);
867 POSIX
::close(2) if $fd != 2;
869 die "unable to redirect STDERR - $!"
870 if !open(STDERR
, ">&1");
872 STDERR-
>autoflush(1);
875 my $msg = "ERROR: $err";
876 POSIX
::write($psync[1], $msg, length ($msg));
877 POSIX
::close($psync[1]);
882 # sync with parent (signal that we are ready)
886 POSIX
::write($psync[1], $upid, length ($upid));
887 POSIX
::close($psync[1]);
891 # sync with parent (wait until parent is ready)
892 POSIX
::read($csync[0], $readbuf, 4096);
893 die "parent setup error\n" if $readbuf ne 'OK';
895 if ($self->{type
} eq 'ha') {
896 print "task started by HA resource agent\n";
898 eval { &$function($upid); };
904 print STDERR
"TASK ERROR: $err\n";
907 print STDERR
"TASK OK\n";
915 POSIX
::close ($psync[1]);
916 POSIX
::close ($csync[0]);
919 # sync with child (wait until child starts)
920 POSIX
::read($psync[0], $readbuf, 4096);
923 POSIX
::close($psync[0]);
924 &$register_worker($cpid, $user, $upid);
930 die "got no worker upid - start worker failed\n" if !$readbuf;
932 if ($readbuf =~ m/^ERROR:\s*(.+)$/m) {
933 die "starting worker failed: $1\n";
936 if ($readbuf ne $upid) {
937 die "got strange worker upid ('$readbuf' != '$upid') - start worker failed\n";
941 $outfh = PVE
::Tools
::upid_open
($upid);
948 POSIX
::write($csync[1], $msg, length ($msg));
949 POSIX
::close($csync[1]);
952 POSIX
::close($csync[1]);
953 kill(-9, $cpid); # make sure it gets killed
957 PVE
::Cluster
::log_msg
('info', $user, "starting task $upid");
959 my $tlist = active_workers
($upid, $sync);
960 PVE
::Cluster
::broadcast_tasklist
($tlist);
969 local $SIG{INT
} = local $SIG{QUIT
} = local $SIG{TERM
} = sub {
970 # always send signal to all pgrp members
972 if ($int_count < 3) {
973 kill(15, $kpid); # send TERM signal
975 kill(9, $kpid); # send KILL signal
979 local $SIG{PIPE
} = sub { die "broken pipe\n"; };
981 my $select = new IO
::Select
;
982 my $fh = IO
::Handle-
>new_from_fd($psync[0], 'r');
985 while ($select->count) {
986 my @handles = $select->can_read(1);
987 if (scalar(@handles)) {
988 my $count = sysread ($handles[0], $readbuf, 4096);
989 if (!defined ($count)) {
991 die "sync pipe read error: $err\n";
993 last if $count == 0; # eof
996 while ($outbuf =~ s/^(([^\010\r\n]*)(\r|\n|(\010)+|\r\n))//s) {
999 if ($data =~ m/^TASK OK$/) {
1001 } elsif ($data =~ m/^TASK ERROR: (.+)$/) {
1002 print STDERR
"$1\n";
1012 # some commands daemonize without closing stdout
1013 last if !PVE
::ProcFSTools
::check_process_running
($cpid);
1019 POSIX
::close($psync[0]);
1021 if ($outbuf) { # just to be sure
1024 print $outfh $outbuf;
1030 print STDERR
"$err\n";
1032 print $outfh "TASK ERROR: $err\n";
1036 &$kill_process_group($cpid, $pstart); # make sure it gets killed
1042 &$log_task_result($upid, $user, $res);
1045 return wantarray ?
($upid, $res) : $upid;