]>
git.proxmox.com Git - pve-access-control.git/blob - PVE/RPCEnvironment.pm
1 package PVE
::RPCEnvironment
;
5 use POSIX
qw(:sys_wait_h EINTR);
13 use PVE
::AccessControl
;
15 # we use this singleton class to pass RPC related environment values
19 # save $SIG{CHLD} handler implementation.
20 # simply set $SIG{CHLD} = $worker_reaper;
21 # and register forked processes with &$register_worker(pid)
22 # Note: using $SIG{CHLD} = 'IGNORE' or $SIG{CHLD} = sub { wait (); } or ...
23 # has serious side effects, because perls built in system() and open()
24 # functions can't get the correct exit status of a child. So we cant use
25 # that (also see perlipc)
29 my $log_task_result = sub {
30 my ($upid, $user, $status) = @_;
32 my $msg = 'successful';
35 my $ec = $status >> 8;
36 my $ic = $status & 255;
37 $msg = $ec ?
"failed ($ec)" : "interrupted ($ic)";
40 my $tlist = active_workers
($upid);
41 PVE
::Cluster
::broadcast_tasklist
($tlist);
43 foreach my $t (@$tlist) {
44 if ($t->{upid
} eq $upid) {
49 if ($task && $task->{status
}) {
50 $msg = $task->{status
};
52 PVE
::Cluster
::log_msg
($pri, $user, "end task $upid $msg");
55 my $worker_reaper = sub {
57 foreach my $pid (keys %$WORKER_PIDS) {
58 my $waitpid = waitpid ($pid, WNOHANG
);
59 if (defined($waitpid) && ($waitpid == $pid)) {
60 my $info = $WORKER_PIDS->{$pid};
61 if ($info && $info->{upid
} && $info->{user
}) {
62 &$log_task_result($info->{upid
}, $info->{user
}, $?);
64 delete ($WORKER_PIDS->{$pid});
69 my $register_worker = sub {
70 my ($pid, $user, $upid) = @_;
74 # do not register if already finished
75 my $waitpid = waitpid ($pid, WNOHANG
);
76 if (defined($waitpid) && ($waitpid == $pid)) {
77 delete ($WORKER_PIDS->{$pid});
81 $WORKER_PIDS->{$pid} = {
89 my $compile_acl = sub {
90 my ($self, $user) = @_;
93 my $cfg = $self->{user_cfg
};
95 return undef if !$cfg->{roles
};
97 if ($user eq 'root@pam') { # root can do anything
98 return {'/' => $cfg->{roles
}->{'Administrator'}};
101 foreach my $path (sort keys %{$cfg->{acl
}}) {
102 my @ra = PVE
::AccessControl
::roles
($cfg, $user, $path);
105 foreach my $role (@ra) {
106 if (my $privset = $cfg->{roles
}->{$role}) {
107 foreach my $p (keys %$privset) {
113 $res->{$path} = $privs;
120 my ($self, $user, $path) = @_;
122 $user = PVE
::AccessControl
::verify_username
($user, 1);
125 my $cache = $self->{aclcache
};
127 my $acl = $cache->{$user};
130 if (!($acl = &$compile_acl($self, $user))) {
133 $cache->{$user} = $acl;
138 if (!($perm = $acl->{$path})) {
140 foreach my $p (sort keys %$acl) {
141 my $final = ($path eq $p);
143 next if !(($p eq '/') || $final || ($path =~ m
|^$p/|));
147 $acl->{$path} = $perm;
154 my ($self, $user, $path, $privs) = @_;
156 my $perm = $self->permissions($user, $path);
158 foreach my $priv (@$privs) {
159 return undef if !$perm->{$priv};
166 my ($self, $user) = @_;
168 my $cfg = $self->{user_cfg
};
169 return PVE
::AccessControl
::user_enabled
($cfg, $user);
172 # initialize environment - must be called once at program startup
174 my ($class, $type, %params) = @_;
176 $class = ref($class) || $class;
178 die "already initialized" if $pve_env;
180 die "unknown environment type" if !$type || $type !~ m/^(cli|pub|priv)$/;
182 $SIG{CHLD
} = $worker_reaper;
185 # cli ... command started fron command line
186 # pub ... access from public server (apache)
187 # priv ... access from private server (pvedaemon)
198 foreach my $p (keys %params) {
199 if ($p eq 'atfork') {
200 $self->{$p} = $params{$p};
202 die "unknown option '$p'";
208 my ($sysname, $nodename) = POSIX
::uname
();
210 $nodename =~ s/\..*$//; # strip domain part, if any
212 $self->{nodename
} = $nodename;
220 die "not initialized" if !$pve_env;
225 # init_request - must be called before each RPC request
227 my ($self, %params) = @_;
229 PVE
::Cluster
::cfs_update
();
231 my $userconfig; # we use this for regression tests
232 foreach my $p (keys %params) {
233 if ($p eq 'userconfig') {
234 $userconfig = $params{$p};
236 die "unknown parameter '$p'";
241 $self->{aclcache
} = {};
243 my $ucdata = PVE
::Tools
::file_get_contents
($userconfig);
244 my $cfg = PVE
::AccessControl
::parse_user_config
($userconfig, $ucdata);
245 $self->{user_cfg
} = $cfg;
247 my $ucvers = PVE
::Cluster
::cfs_file_version
('user.cfg');
248 if (!$self->{aclcache
} || !defined($self->{aclversion
}) ||
249 !defined($ucvers) || ($ucvers ne $self->{aclversion
})) {
250 $self->{aclversion
} = $ucvers;
251 my $cfg = PVE
::Cluster
::cfs_read_file
('user.cfg');
252 $self->{user_cfg
} = $cfg;
257 $self->{user_cfg
} = {};
258 die "Unable to load access control list: $err";
263 my ($self, $ip) = @_;
265 $self->{client_ip
} = $ip;
271 return $self->{client_ip
};
274 sub set_result_count
{
275 my ($self, $count) = @_;
277 $self->{result_count
} = $count;
280 sub get_result_count
{
283 return $self->{result_count
};
287 my ($self, $lang) = @_;
289 # fixme: initialize I18N
291 $self->{language
} = $lang;
297 return $self->{language
};
301 my ($self, $user) = @_;
305 $self->{user
} = $user;
311 die "user name not set\n" if !$self->{user
};
313 return $self->{user
};
316 # read/update list of active workers
317 # we move all finished tasks to the archive index,
318 # but keep aktive and most recent task in the active file.
319 # $nocheck ... consider $new_upid still running (avoid that
320 # we try to read the reult to early.
322 my ($new_upid, $nocheck) = @_;
324 my $lkfn = "/var/log/pve/tasks/.active.lock";
330 my $tasklist = PVE
::INotify
::read_file
('active');
334 my $thash = {}; # only list task once
336 my $check_task = sub {
337 my ($task, $running) = @_;
339 if ($running || PVE
::ProcFSTools
::check_process_running
($task->{pid
}, $task->{pstart
})) {
345 delete $task->{pstart
};
348 foreach my $task (@$tasklist) {
349 my $upid = $task->{upid
};
350 next if $thash->{$upid};
351 $thash->{$upid} = $task;
355 if ($new_upid && !(my $task = $thash->{$new_upid})) {
356 $task = PVE
::Tools
::upid_decode
($new_upid);
357 $task->{upid
} = $new_upid;
358 $thash->{$new_upid} = $task;
359 &$check_task($task, $nocheck);
363 @ta = sort { $b->{starttime
} cmp $a->{starttime
} } @ta;
365 my $save = defined($new_upid);
367 foreach my $task (@ta) {
368 next if $task->{endtime
};
369 $task->{endtime
} = time();
370 $task->{status
} = PVE
::Tools
::upid_read_status
($task->{upid
});
376 foreach my $task (@ta) {
377 if (!$task->{saved
}) {
378 $archive .= sprintf("$task->{upid} %08X $task->{status}\n", $task->{endtime
});
387 my $filename = "/var/log/pve/tasks/index";
389 my $fh = IO
::File-
>new($filename, '>>', 0644) ||
390 die "unable to open file '$filename' - $!\n";
391 PVE
::Tools
::safe_print
($filename, $fh, $archive);
394 die "unable to close file '$filename' - $!\n";
399 foreach my $task (@arlist) { # mark as not saved
403 my $maxsize = 50000; # about 1000 entries
404 if ($size > $maxsize) {
405 rename($filename, "$filename.1");
409 # we try to reduce the amount of data
410 # list all running tasks and task and a few others
411 # try to limit to 25 tasks
413 my $max = 25 - scalar(@$tlist);
414 foreach my $task (@ta) {
420 PVE
::INotify
::write_file
('active', $tlist) if $save;
425 my $res = PVE
::Tools
::lock_file
($lkfn, $timeout, $code);
431 my $kill_process_group = sub {
432 my ($pid, $pstart) = @_;
434 # send kill to process group (negative pid)
437 # always send signal to all pgrp members
438 kill(15, $kpid); # send TERM signal
440 # give max 5 seconds to shut down
441 for (my $i = 0; $i < 5; $i++) {
442 return if !PVE
::ProcFSTools
::check_process_running
($pid, $pstart);
451 my ($upid, $killit) = @_;
453 my $task = PVE
::Tools
::upid_decode
($upid);
455 my $running = PVE
::ProcFSTools
::check_process_running
($task->{pid
}, $task->{pstart
});
457 return 0 if !$running;
460 &$kill_process_group($task->{pid
});
467 # start long running workers
468 # STDIN is redirected to /dev/null
469 # STDOUT,STDERR are redirected to the filename returned by upid_decode
470 # NOTE: we simulate running in foreground if ($self->{type} eq 'cli')
472 my ($self, $dtype, $id, $user, $function) = @_;
474 $dtype = 'unknown' if !defined ($dtype);
475 $id = '' if !defined ($id);
477 $user = 'root@pve' if !defined ($user);
479 my $sync = $self->{type
} eq 'cli' ?
1 : 0;
484 local $SIG{TERM
} = 'IGNORE';
486 my $starttime = time ();
488 my @psync = POSIX
::pipe();
489 my @csync = POSIX
::pipe();
491 my $node = $self->{nodename
};
494 die "unable to fork worker - $!" if !defined($cpid);
496 my $workerpuid = $cpid ?
$cpid : $$;
498 my $pstart = PVE
::ProcFSTools
::read_proc_starttime
($workerpuid) ||
499 die "unable to read process start time";
501 my $upid = PVE
::Tools
::upid_encode
({
502 node
=> $node, pid
=> $workerpuid, pstart
=> $pstart,
503 starttime
=> $starttime, type
=> $dtype, id
=> $id, user
=> $user });
507 if (!$cpid) { # child
511 $SIG{INT
} = $SIG{QUIT
} = $SIG{TERM
} = sub { die "received interrupt\n"; };
513 $SIG{CHLD
} = $SIG{PIPE
} = 'DEFAULT';
515 # set sess/process group - we want to be able to kill the
516 # whole process group
519 POSIX
::close ($psync[0]);
520 POSIX
::close ($csync[1]);
522 $outfh = $sync ?
$psync[1] : undef;
525 PVE
::INotify
::inotify_close
();
527 if (my $atfork = $self->{atfork
}) {
531 # same algorythm as used inside SA
533 my $fd = fileno (STDIN
);
535 POSIX
::close(0) if $fd != 0;
537 die "unable to redirect STDIN - $!"
538 if !open(STDIN
, "</dev/null");
540 $outfh = PVE
::Tools
::upid_open
($upid) if !$sync;
543 $fd = fileno(STDOUT
);
545 POSIX
::close (1) if $fd != 1;
547 die "unable to redirect STDOUT - $!"
548 if !open(STDOUT
, ">&", $outfh);
550 STDOUT-
>autoflush (1);
552 # redirect STDERR to STDOUT
553 $fd = fileno (STDERR
);
555 POSIX
::close(2) if $fd != 2;
557 die "unable to redirect STDERR - $!"
558 if !open(STDERR
, ">&1");
560 STDERR-
>autoflush(1);
563 my $msg = "ERROR: $err";
564 POSIX
::write($psync[1], $msg, length ($msg));
565 POSIX
::close($psync[1]);
570 # sync with parent (signal that we are ready)
574 POSIX
::write($psync[1], $upid, length ($upid));
575 POSIX
::close($psync[1]);
579 # sync with parent (wait until parent is ready)
580 POSIX
::read($csync[0], $readbuf, 4096);
581 die "parent setup error\n" if $readbuf ne 'OK';
583 eval { &$function($upid); };
589 print STDERR
"TASK ERROR: $err\n";
592 print STDERR
"TASK OK\n";
600 POSIX
::close ($psync[1]);
601 POSIX
::close ($csync[0]);
604 # sync with child (wait until child starts)
605 POSIX
::read($psync[0], $readbuf, 4096);
608 POSIX
::close($psync[0]);
609 &$register_worker($cpid, $user, $upid);
615 die "got no worker upid - start worker failed\n" if !$readbuf;
617 if ($readbuf =~ m/^ERROR:\s*(.+)$/m) {
618 die "starting worker failed: $1\n";
621 if ($readbuf ne $upid) {
622 die "got strange worker upid ('$readbuf' != '$upid') - start worker failed\n";
626 $outfh = PVE
::Tools
::upid_open
($upid);
633 POSIX
::write($csync[1], $msg, length ($msg));
634 POSIX
::close($csync[1]);
637 POSIX
::close($csync[1]);
638 kill(-9, $cpid); # make sure it gets killed
642 PVE
::Cluster
::log_msg
('info', $user, "starting task $upid");
644 my $tlist = active_workers
($upid, $sync);
645 PVE
::Cluster
::broadcast_tasklist
($tlist);
654 local $SIG{INT
} = local $SIG{QUIT
} = local $SIG{TERM
} = sub {
655 if ($int_count < 3) {
656 kill(15, $cpid); # send TERM signal
658 kill(9, $cpid); # send KILL signal
662 local $SIG{PIPE
} = sub { die "broken pipe\n"; };
665 if (!defined($count = POSIX
::read($psync[0], $readbuf, 4096))) {
669 last if $count == 0; # eof
672 while ($outbuf =~ s/^(([^\010\r\n]*)(\r|\n|(\010)+|\r\n))//s) {
675 if ($data =~ m/^TASK OK$/) {
677 } elsif ($data =~ m/^TASK ERROR: (.+)$/) {
691 POSIX
::close($psync[0]);
693 if ($outbuf) { # just to be sure
696 print $outfh $outbuf;
702 print STDERR
"$err\n";
704 print $outfh "TASK ERROR: $err\n";
708 &$kill_process_group($cpid, $pstart); # make sure it gets killed
714 &$log_task_result($upid, $user, $res);
717 return wantarray ?
($upid, $res) : $upid;