]>
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));
239 sub check_user_enabled
{
240 my ($self, $user, $noerr) = @_;
242 my $cfg = $self->{user_cfg
};
243 return PVE
::AccessControl
::check_user_enabled
($cfg, $user, $noerr);
246 sub check_user_exist
{
247 my ($self, $user, $noerr) = @_;
249 my $cfg = $self->{user_cfg
};
250 return PVE
::AccessControl
::check_user_exist
($cfg, $user, $noerr);
253 sub is_group_member
{
254 my ($self, $group, $user) = @_;
256 my $cfg = $self->{user_cfg
};
258 return 0 if !$cfg->{groups
}->{$group};
260 return defined($cfg->{groups
}->{$group}->{users
}->{$user});
264 my ($self, $user, $privs, $any) = @_;
266 my $cfg = $self->{user_cfg
};
269 foreach my $group (keys %{$cfg->{groups
}}) {
270 my $path = "/access/groups/$group";
272 if ($self->check_any($user, $path, $privs, 1)) {
273 $groups->{$group} = $cfg->{groups
}->{$group};
276 if ($self->check($user, $path, $privs, 1)) {
277 $groups->{$group} = $cfg->{groups
}->{$group};
285 sub group_member_join
{
286 my ($self, $grouplist) = @_;
290 my $cfg = $self->{user_cfg
};
291 foreach my $group (@$grouplist) {
292 my $data = $cfg->{groups
}->{$group};
294 foreach my $user (keys %{$data->{users
}}) {
302 sub check_perm_modify
{
303 my ($self, $username, $path, $noerr) = @_;
305 return $self->check($username, '/access', [ 'Permissions.Modify' ], $noerr) if !$path;
307 my $testperms = [ 'Permissions.Modify' ];
308 if ($path =~ m
|^/storage/.+$|) {
309 push @$testperms, 'Datastore.Allocate';
310 } elsif ($path =~ m
|^/vms/.+$|) {
311 push @$testperms, 'VM.Allocate';
312 } elsif ($path =~ m
|^/pool/.+$|) {
313 push @$testperms, 'Pool.Allocate';
316 return $self->check_any($username, $path, $testperms, $noerr);
319 sub exec_api2_perm_check
{
320 my ($self, $check, $username, $param, $noerr) = @_;
322 # syslog("info", "CHECK " . join(', ', @$check));
325 my $test = $check->[$ind++];
326 die "no permission test specified" if !$test;
328 if ($test eq 'and') {
329 while (my $subcheck = $check->[$ind++]) {
330 $self->exec_api2_perm_check($subcheck, $username, $param);
333 } elsif ($test eq 'or') {
334 while (my $subcheck = $check->[$ind++]) {
335 return 1 if $self->exec_api2_perm_check($subcheck, $username, $param, 1);
339 } elsif ($test eq 'perm') {
340 my ($t, $tmplpath, $privs, %options) = @$check;
341 my $any = $options{any
};
342 die "missing parameters" if !($tmplpath && $privs);
343 my $path = PVE
::Tools
::template_replace
($tmplpath, $param);
344 $path = PVE
::AccessControl
::normalize_path
($path);
346 return $self->check_any($username, $path, $privs, $noerr);
348 return $self->check($username, $path, $privs, $noerr);
350 } elsif ($test eq 'userid-group') {
351 my $userid = $param->{userid
};
352 my ($t, $privs, %options) = @$check;
353 return 0 if !$options{groups_param
} && !$self->check_user_exist($userid, $noerr);
354 if (!$self->check_any($username, "/access/groups", $privs, 1)) {
355 my $groups = $self->filter_groups($username, $privs, 1);
356 if ($options{groups_param
}) {
357 my @group_param = PVE
::Tools
::split_list
($param->{groups
});
358 raise_perm_exc
("/access/groups, " . join("|", @$privs)) if !scalar(@group_param);
359 foreach my $pg (@group_param) {
360 raise_perm_exc
("/access/groups/$pg, " . join("|", @$privs))
364 my $allowed_users = $self->group_member_join([keys %$groups]);
365 if (!$allowed_users->{$userid}) {
372 } elsif ($test eq 'userid-param') {
373 my ($userid, undef, $realm) = verify_username
($param->{userid
});
374 return if !$self->check_user_exist($userid, $noerr);
375 my ($t, $subtest) = @$check;
376 die "missing parameters" if !$subtest;
377 if ($subtest eq 'self') {
378 return 1 if $username eq 'userid';
381 } elsif ($subtest eq 'Realm.AllocateUser') {
382 my $path = "/access/realm/$realm";
383 return $self->check($username, $path, ['Realm.AllocateUser'], $noerr);
385 raise_perm_exc
("$path, 'Realm.AllocateUser'");
387 die "unknown userid-param test";
389 } elsif ($test eq 'perm-modify') {
390 my ($t, $tmplpath) = @$check;
391 my $path = PVE
::Tools
::template_replace
($tmplpath, $param);
392 $path = PVE
::AccessControl
::normalize_path
($path);
393 return $self->check_perm_modify($username, $path, $noerr);
395 die "unknown permission test";
399 sub check_api2_permissions
{
400 my ($self, $perm, $username, $param) = @_;
402 return 1 if !$username && $perm->{user
} eq 'world';
404 raise_perm_exc
("user != null") if !$username;
406 return 1 if $username eq 'root@pam';
408 raise_perm_exc
('user != root@pam') if !$perm;
410 return 1 if $perm->{user
} && $perm->{user
} eq 'all';
412 return $self->exec_api2_perm_check($perm->{check
}, $username, $param)
418 # initialize environment - must be called once at program startup
420 my ($class, $type, %params) = @_;
422 $class = ref($class) || $class;
424 die "already initialized" if $pve_env;
426 die "unknown environment type" if !$type || $type !~ m/^(cli|pub|priv|ha)$/;
428 $SIG{CHLD
} = $worker_reaper;
431 # cli ... command started fron command line
432 # pub ... access from public server (apache)
433 # priv ... access from private server (pvedaemon)
434 # ha ... access from HA resource manager agent (rgmanager)
445 foreach my $p (keys %params) {
446 if ($p eq 'atfork') {
447 $self->{$p} = $params{$p};
449 die "unknown option '$p'";
455 my ($sysname, $nodename) = POSIX
::uname
();
457 $nodename =~ s/\..*$//; # strip domain part, if any
459 $self->{nodename
} = $nodename;
467 die "not initialized" if !$pve_env;
473 my ($self, $enable_upload) = @_;
475 if ($self->{request_rec
}) {
477 if ($enable_upload) {
478 $cgi = CGI-
>new($self->{request_rec
});
480 # disable upload using empty upload_hook
481 $cgi = CGI-
>new($self->{request_rec
}, sub {}, undef, 0);
484 my $params = $cgi->Vars();
485 return PVE
::Tools
::decode_utf8_parameters
($params);
486 } elsif ($self->{params
}) {
487 return $self->{params
};
489 die "no parameters registered";
493 sub get_upload_info
{
494 my ($self, $param) = @_;
496 my $cgi = $self->{cgi
};
497 die "CGI not initialized" if !$cgi;
499 my $pd = $cgi->param($param);
500 die "unable to get cgi parameter info\n" if !$pd;
501 my $info = $cgi->uploadInfo($pd);
502 die "unable to get cgi upload info\n" if !$info;
504 my $res = { %$info };
506 my $tmpfilename = $cgi->tmpFileName($pd);
507 die "unable to get cgi upload file name\n" if !$tmpfilename;
508 $res->{tmpfilename
} = $tmpfilename;
510 #my $hndl = $cgi->upload($param);
511 #die "unable to get cgi upload handle\n" if !$hndl;
512 #$res->{handle} = $hndl->handle;
517 # init_request - must be called before each RPC request
519 my ($self, %params) = @_;
521 PVE
::Cluster
::cfs_update
();
523 $self->{result_attributes
} = {};
525 my $userconfig; # we use this for regression tests
526 foreach my $p (keys %params) {
527 if ($p eq 'userconfig') {
528 $userconfig = $params{$p};
529 } elsif ($p eq 'request_rec') {
530 # pass Apache2::RequestRec
531 $self->{request_rec
} = $params{$p};
532 } elsif ($p eq 'params') {
533 $self->{params
} = $params{$p};
535 die "unknown parameter '$p'";
540 $self->{aclcache
} = {};
542 my $ucdata = PVE
::Tools
::file_get_contents
($userconfig);
543 my $cfg = PVE
::AccessControl
::parse_user_config
($userconfig, $ucdata);
544 $self->{user_cfg
} = $cfg;
547 my $ucvers = PVE
::Cluster
::cfs_file_version
('user.cfg');
548 if (!$self->{aclcache
} || !defined($self->{aclversion
}) ||
549 !defined($ucvers) || ($ucvers ne $self->{aclversion
})) {
550 $self->{aclversion
} = $ucvers;
551 my $cfg = PVE
::Cluster
::cfs_read_file
('user.cfg');
552 $self->{user_cfg
} = $cfg;
557 $self->{user_cfg
} = {};
558 die "Unable to load access control list: $err";
563 my ($self, $ip) = @_;
565 $self->{client_ip
} = $ip;
571 return $self->{client_ip
};
574 sub set_result_attrib
{
575 my ($self, $key, $value) = @_;
577 $self->{result_attributes
}->{$key} = $value;
580 sub get_result_attrib
{
581 my ($self, $key) = @_;
583 return $self->{result_attributes
}->{$key};
587 my ($self, $lang) = @_;
589 # fixme: initialize I18N
591 $self->{language
} = $lang;
597 return $self->{language
};
601 my ($self, $user) = @_;
605 $self->{user
} = $user;
611 die "user name not set\n" if !$self->{user
};
613 return $self->{user
};
616 # read/update list of active workers
617 # we move all finished tasks to the archive index,
618 # but keep aktive and most recent task in the active file.
619 # $nocheck ... consider $new_upid still running (avoid that
620 # we try to read the reult to early.
622 my ($new_upid, $nocheck) = @_;
624 my $lkfn = "/var/log/pve/tasks/.active.lock";
630 my $tasklist = PVE
::INotify
::read_file
('active');
634 my $thash = {}; # only list task once
636 my $check_task = sub {
637 my ($task, $running) = @_;
639 if ($running || PVE
::ProcFSTools
::check_process_running
($task->{pid
}, $task->{pstart
})) {
645 delete $task->{pstart
};
648 foreach my $task (@$tasklist) {
649 my $upid = $task->{upid
};
650 next if $thash->{$upid};
651 $thash->{$upid} = $task;
655 if ($new_upid && !(my $task = $thash->{$new_upid})) {
656 $task = PVE
::Tools
::upid_decode
($new_upid);
657 $task->{upid
} = $new_upid;
658 $thash->{$new_upid} = $task;
659 &$check_task($task, $nocheck);
663 @ta = sort { $b->{starttime
} cmp $a->{starttime
} } @ta;
665 my $save = defined($new_upid);
667 foreach my $task (@ta) {
668 next if $task->{endtime
};
669 $task->{endtime
} = time();
670 $task->{status
} = PVE
::Tools
::upid_read_status
($task->{upid
});
676 foreach my $task (@ta) {
677 if (!$task->{saved
}) {
678 $archive .= sprintf("$task->{upid} %08X $task->{status}\n", $task->{endtime
});
687 my $filename = "/var/log/pve/tasks/index";
689 my $fh = IO
::File-
>new($filename, '>>', 0644) ||
690 die "unable to open file '$filename' - $!\n";
691 PVE
::Tools
::safe_print
($filename, $fh, $archive);
694 die "unable to close file '$filename' - $!\n";
699 foreach my $task (@arlist) { # mark as not saved
703 my $maxsize = 50000; # about 1000 entries
704 if ($size > $maxsize) {
705 rename($filename, "$filename.1");
709 # we try to reduce the amount of data
710 # list all running tasks and task and a few others
711 # try to limit to 25 tasks
713 my $max = 25 - scalar(@$tlist);
714 foreach my $task (@ta) {
720 PVE
::INotify
::write_file
('active', $tlist) if $save;
725 my $res = PVE
::Tools
::lock_file
($lkfn, $timeout, $code);
731 my $kill_process_group = sub {
732 my ($pid, $pstart) = @_;
734 # send kill to process group (negative pid)
737 # always send signal to all pgrp members
738 kill(15, $kpid); # send TERM signal
740 # give max 5 seconds to shut down
741 for (my $i = 0; $i < 5; $i++) {
742 return if !PVE
::ProcFSTools
::check_process_running
($pid, $pstart);
751 my ($upid, $killit) = @_;
753 my $task = PVE
::Tools
::upid_decode
($upid);
755 my $running = PVE
::ProcFSTools
::check_process_running
($task->{pid
}, $task->{pstart
});
757 return 0 if !$running;
760 &$kill_process_group($task->{pid
});
767 # start long running workers
768 # STDIN is redirected to /dev/null
769 # STDOUT,STDERR are redirected to the filename returned by upid_decode
770 # NOTE: we simulate running in foreground if ($self->{type} eq 'cli')
772 my ($self, $dtype, $id, $user, $function) = @_;
774 $dtype = 'unknown' if !defined ($dtype);
775 $id = '' if !defined ($id);
777 $user = 'root@pve' if !defined ($user);
779 my $sync = $self->{type
} eq 'cli' ?
1 : 0;
784 local $SIG{TERM
} = 'IGNORE';
786 my $starttime = time ();
788 my @psync = POSIX
::pipe();
789 my @csync = POSIX
::pipe();
791 my $node = $self->{nodename
};
794 die "unable to fork worker - $!" if !defined($cpid);
796 my $workerpuid = $cpid ?
$cpid : $$;
798 my $pstart = PVE
::ProcFSTools
::read_proc_starttime
($workerpuid) ||
799 die "unable to read process start time";
801 my $upid = PVE
::Tools
::upid_encode
({
802 node
=> $node, pid
=> $workerpuid, pstart
=> $pstart,
803 starttime
=> $starttime, type
=> $dtype, id
=> $id, user
=> $user });
807 if (!$cpid) { # child
811 $SIG{INT
} = $SIG{QUIT
} = $SIG{TERM
} = sub { die "received interrupt\n"; };
813 $SIG{CHLD
} = $SIG{PIPE
} = 'DEFAULT';
815 # set sess/process group - we want to be able to kill the
816 # whole process group
819 POSIX
::close ($psync[0]);
820 POSIX
::close ($csync[1]);
822 $outfh = $sync ?
$psync[1] : undef;
825 PVE
::INotify
::inotify_close
();
827 if (my $atfork = $self->{atfork
}) {
831 # same algorythm as used inside SA
833 my $fd = fileno (STDIN
);
837 POSIX
::close(0) if $fd != 0;
839 die "unable to redirect STDIN - $!"
840 if !open(STDIN
, "</dev/null");
842 $outfh = PVE
::Tools
::upid_open
($upid);
847 $fd = fileno(STDOUT
);
849 POSIX
::close (1) if $fd != 1;
851 die "unable to redirect STDOUT - $!"
852 if !open(STDOUT
, ">&", $outfh);
854 STDOUT-
>autoflush (1);
856 # redirect STDERR to STDOUT
857 $fd = fileno (STDERR
);
859 POSIX
::close(2) if $fd != 2;
861 die "unable to redirect STDERR - $!"
862 if !open(STDERR
, ">&1");
864 STDERR-
>autoflush(1);
867 my $msg = "ERROR: $err";
868 POSIX
::write($psync[1], $msg, length ($msg));
869 POSIX
::close($psync[1]);
874 # sync with parent (signal that we are ready)
878 POSIX
::write($psync[1], $upid, length ($upid));
879 POSIX
::close($psync[1]);
883 # sync with parent (wait until parent is ready)
884 POSIX
::read($csync[0], $readbuf, 4096);
885 die "parent setup error\n" if $readbuf ne 'OK';
887 if ($self->{type
} eq 'ha') {
888 print "task started by HA resource agent\n";
890 eval { &$function($upid); };
896 print STDERR
"TASK ERROR: $err\n";
899 print STDERR
"TASK OK\n";
907 POSIX
::close ($psync[1]);
908 POSIX
::close ($csync[0]);
911 # sync with child (wait until child starts)
912 POSIX
::read($psync[0], $readbuf, 4096);
915 POSIX
::close($psync[0]);
916 &$register_worker($cpid, $user, $upid);
922 die "got no worker upid - start worker failed\n" if !$readbuf;
924 if ($readbuf =~ m/^ERROR:\s*(.+)$/m) {
925 die "starting worker failed: $1\n";
928 if ($readbuf ne $upid) {
929 die "got strange worker upid ('$readbuf' != '$upid') - start worker failed\n";
933 $outfh = PVE
::Tools
::upid_open
($upid);
940 POSIX
::write($csync[1], $msg, length ($msg));
941 POSIX
::close($csync[1]);
944 POSIX
::close($csync[1]);
945 kill(-9, $cpid); # make sure it gets killed
949 PVE
::Cluster
::log_msg
('info', $user, "starting task $upid");
951 my $tlist = active_workers
($upid, $sync);
952 PVE
::Cluster
::broadcast_tasklist
($tlist);
961 local $SIG{INT
} = local $SIG{QUIT
} = local $SIG{TERM
} = sub {
962 # always send signal to all pgrp members
964 if ($int_count < 3) {
965 kill(15, $kpid); # send TERM signal
967 kill(9, $kpid); # send KILL signal
971 local $SIG{PIPE
} = sub { die "broken pipe\n"; };
973 my $select = new IO
::Select
;
974 my $fh = IO
::Handle-
>new_from_fd($psync[0], 'r');
977 while ($select->count) {
978 my @handles = $select->can_read(1);
979 if (scalar(@handles)) {
980 my $count = sysread ($handles[0], $readbuf, 4096);
981 if (!defined ($count)) {
983 die "sync pipe read error: $err\n";
985 last if $count == 0; # eof
988 while ($outbuf =~ s/^(([^\010\r\n]*)(\r|\n|(\010)+|\r\n))//s) {
991 if ($data =~ m/^TASK OK$/) {
993 } elsif ($data =~ m/^TASK ERROR: (.+)$/) {
1004 # some commands daemonize without closing stdout
1005 last if !PVE
::ProcFSTools
::check_process_running
($cpid);
1011 POSIX
::close($psync[0]);
1013 if ($outbuf) { # just to be sure
1016 print $outfh $outbuf;
1022 print STDERR
"$err\n";
1024 print $outfh "TASK ERROR: $err\n";
1028 &$kill_process_group($cpid, $pstart); # make sure it gets killed
1034 &$log_task_result($upid, $user, $res);
1037 return wantarray ?
($upid, $res) : $upid;