create correct man page and .pod
[pve-access-control.git] / PVE / RPCEnvironment.pm
CommitLineData
2c3a6c0a
DM
1package PVE::RPCEnvironment;
2
3use strict;
4use warnings;
8d6e045f 5use POSIX qw(:sys_wait_h EINTR);
2c3a6c0a
DM
6use IO::File;
7use Fcntl qw(:flock);
8use PVE::SafeSyslog;
9use PVE::Tools;
10use PVE::INotify;
11use PVE::Cluster;
12use PVE::ProcFSTools;
13use PVE::AccessControl;
14
15# we use this singleton class to pass RPC related environment values
16
17my $pve_env;
18
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)
26
27my $WORKER_PIDS;
28
29my $log_task_result = sub {
30 my ($upid, $user, $status) = @_;
31
32 my $msg = 'successful';
33 my $pri = 'info';
34 if ($status != 0) {
35 my $ec = $status >> 8;
36 my $ic = $status & 255;
37 $msg = $ec ? "failed ($ec)" : "interrupted ($ic)";
38 $pri = 'err';
39 }
40 my $tlist = active_workers($upid);
41 PVE::Cluster::broadcast_tasklist($tlist);
42 my $task;
43 foreach my $t (@$tlist) {
44 if ($t->{upid} eq $upid) {
45 $task = $t;
46 last;
47 }
48 }
49 if ($task && $task->{status}) {
50 $msg = $task->{status};
51 }
52 PVE::Cluster::log_msg($pri, $user, "end task $upid $msg");
53};
54
55my $worker_reaper = sub {
56 local $!; local $?;
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}, $?);
63 }
64 delete ($WORKER_PIDS->{$pid});
65 }
66 }
67};
68
69my $register_worker = sub {
70 my ($pid, $user, $upid) = @_;
71
72 return if !$pid;
73
74 # do not register if already finished
75 my $waitpid = waitpid ($pid, WNOHANG);
76 if (defined($waitpid) && ($waitpid == $pid)) {
77 delete ($WORKER_PIDS->{$pid});
78 return;
79 }
80
81 $WORKER_PIDS->{$pid} = {
82 user => $user,
83 upid => $upid,
84 };
85};
86
87# ACL cache
88
89my $compile_acl = sub {
90 my ($self, $user) = @_;
91
92 my $res = {};
93 my $cfg = $self->{user_cfg};
94
95 return undef if !$cfg->{roles};
96
97 if ($user eq 'root@pam') { # root can do anything
98 return {'/' => $cfg->{roles}->{'Administrator'}};
99 }
100
101 foreach my $path (sort keys %{$cfg->{acl}}) {
102 my @ra = PVE::AccessControl::roles($cfg, $user, $path);
103
104 my $privs = {};
105 foreach my $role (@ra) {
106 if (my $privset = $cfg->{roles}->{$role}) {
107 foreach my $p (keys %$privset) {
108 $privs->{$p} = 1;
109 }
110 }
111 }
112
113 $res->{$path} = $privs;
114 }
115
116 return $res;
117};
118
119sub permissions {
120 my ($self, $user, $path) = @_;
121
122 $user = PVE::AccessControl::verify_username($user, 1);
123 return {} if !$user;
124
125 my $cache = $self->{aclcache};
126
127 my $acl = $cache->{$user};
128
129 if (!$acl) {
130 if (!($acl = &$compile_acl($self, $user))) {
131 return {};
132 }
133 $cache->{$user} = $acl;
134 }
135
136 my $perm;
137
138 if (!($perm = $acl->{$path})) {
139 $perm = {};
140 foreach my $p (sort keys %$acl) {
141 my $final = ($path eq $p);
142
143 next if !(($p eq '/') || $final || ($path =~ m|^$p/|));
144
145 $perm = $acl->{$p};
146 }
147 $acl->{$path} = $perm;
148 }
149
150 return $perm;
151}
152
153sub check {
154 my ($self, $user, $path, $privs) = @_;
155
156 my $perm = $self->permissions($user, $path);
157
158 foreach my $priv (@$privs) {
159 return undef if !$perm->{$priv};
160 };
161
162 return 1;
163};
164
165sub user_enabled {
166 my ($self, $user) = @_;
167
168 my $cfg = $self->{user_cfg};
169 return PVE::AccessControl::user_enabled($cfg, $user);
170}
171
172# initialize environment - must be called once at program startup
173sub init {
174 my ($class, $type, %params) = @_;
175
176 $class = ref($class) || $class;
177
178 die "already initialized" if $pve_env;
179
180 die "unknown environment type" if !$type || $type !~ m/^(cli|pub|priv)$/;
181
182 $SIG{CHLD} = $worker_reaper;
183
184 # environment types
185 # cli ... command started fron command line
186 # pub ... access from public server (apache)
187 # priv ... access from private server (pvedaemon)
188
189 my $self = {
190 user_cfg => {},
191 aclcache => {},
192 aclversion => undef,
193 type => $type,
194 };
195
196 bless $self, $class;
197
198 foreach my $p (keys %params) {
199 if ($p eq 'atfork') {
200 $self->{$p} = $params{$p};
201 } else {
202 die "unknown option '$p'";
203 }
204 }
205
206 $pve_env = $self;
207
208 my ($sysname, $nodename) = POSIX::uname();
209
210 $nodename =~ s/\..*$//; # strip domain part, if any
211
212 $self->{nodename} = $nodename;
213
214 return $self;
215};
216
217# get the singleton
218sub get {
219
220 die "not initialized" if !$pve_env;
221
222 return $pve_env;
223}
224
225# init_request - must be called before each RPC request
226sub init_request {
227 my ($self, %params) = @_;
228
229 PVE::Cluster::cfs_update();
230
231 my $userconfig; # we use this for regression tests
232 foreach my $p (keys %params) {
233 if ($p eq 'userconfig') {
234 $userconfig = $params{$p};
235 } else {
236 die "unknown parameter '$p'";
237 }
238 }
239
240 eval {
241 $self->{aclcache} = {};
242 if ($userconfig) {
243 my $ucdata = PVE::Tools::file_get_contents($userconfig);
244 my $cfg = PVE::AccessControl::parse_user_config($userconfig, $ucdata);
245 $self->{user_cfg} = $cfg;
246 } else {
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;
253 }
254 }
255 };
256 if (my $err = $@) {
257 $self->{user_cfg} = {};
258 die "Unable to load access control list: $err";
259 }
260}
261
262sub set_client_ip {
263 my ($self, $ip) = @_;
264
265 $self->{client_ip} = $ip;
266}
267
268sub get_client_ip {
269 my ($self) = @_;
270
271 return $self->{client_ip};
272}
273
274sub set_result_count {
275 my ($self, $count) = @_;
276
277 $self->{result_count} = $count;
278}
279
280sub get_result_count {
281 my ($self) = @_;
282
283 return $self->{result_count};
284}
285
286sub set_language {
287 my ($self, $lang) = @_;
288
289 # fixme: initialize I18N
290
291 $self->{language} = $lang;
292}
293
294sub get_language {
295 my ($self) = @_;
296
297 return $self->{language};
298}
299
300sub set_user {
301 my ($self, $user) = @_;
302
303 # fixme: get ACLs
304
305 $self->{user} = $user;
306}
307
308sub get_user {
309 my ($self) = @_;
310
311 die "user name not set\n" if !$self->{user};
312
313 return $self->{user};
314}
315
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.
5bf71a96
DM
319# $nocheck ... consider $new_upid still running (avoid that
320# we try to read the reult to early.
2c3a6c0a 321sub active_workers {
5bf71a96 322 my ($new_upid, $nocheck) = @_;
2c3a6c0a
DM
323
324 my $lkfn = "/var/log/pve/tasks/.active.lock";
325
326 my $timeout = 10;
327
328 my $code = sub {
329
330 my $tasklist = PVE::INotify::read_file('active');
331
332 my @ta;
333 my $tlist = [];
334 my $thash = {}; # only list task once
335
336 my $check_task = sub {
d33d0735 337 my ($task, $running) = @_;
2c3a6c0a 338
d33d0735 339 if ($running || PVE::ProcFSTools::check_process_running($task->{pid}, $task->{pstart})) {
2c3a6c0a
DM
340 push @$tlist, $task;
341 } else {
342 delete $task->{pid};
343 push @ta, $task;
344 }
345 delete $task->{pstart};
346 };
347
348 foreach my $task (@$tasklist) {
349 my $upid = $task->{upid};
350 next if $thash->{$upid};
351 $thash->{$upid} = $task;
352 &$check_task($task);
353 }
354
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;
d33d0735 359 &$check_task($task, $nocheck);
2c3a6c0a
DM
360 }
361
362
363 @ta = sort { $b->{starttime} cmp $a->{starttime} } @ta;
364
365 my $save = defined($new_upid);
366
367 foreach my $task (@ta) {
368 next if $task->{endtime};
369 $task->{endtime} = time();
370 $task->{status} = PVE::Tools::upid_read_status($task->{upid});
371 $save = 1;
372 }
373
374 my $archive = '';
375 my @arlist = ();
376 foreach my $task (@ta) {
377 if (!$task->{saved}) {
378 $archive .= sprintf("$task->{upid} %08X $task->{status}\n", $task->{endtime});
379 $save = 1;
380 push @arlist, $task;
381 $task->{saved} = 1;
382 }
383 }
384
385 if ($archive) {
386 my $size = 0;
387 my $filename = "/var/log/pve/tasks/index";
388 eval {
389 my $fh = IO::File->new($filename, '>>', 0644) ||
390 die "unable to open file '$filename' - $!\n";
391 PVE::Tools::safe_print($filename, $fh, $archive);
392 $size = -s $fh;
393 close($fh) ||
394 die "unable to close file '$filename' - $!\n";
395 };
396 my $err = $@;
397 if ($err) {
398 syslog('err', $err);
399 foreach my $task (@arlist) { # mark as not saved
400 $task->{saved} = 0;
401 }
402 }
403 my $maxsize = 50000; # about 1000 entries
404 if ($size > $maxsize) {
405 rename($filename, "$filename.1");
406 }
407 }
408
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
412 my $ctime = time();
413 my $max = 25 - scalar(@$tlist);
414 foreach my $task (@ta) {
415 last if $max <= 0;
416 push @$tlist, $task;
417 $max--;
418 }
419
420 PVE::INotify::write_file('active', $tlist) if $save;
421
422 return $tlist;
423 };
424
425 my $res = PVE::Tools::lock_file($lkfn, $timeout, $code);
426 die $@ if $@;
427
428 return $res;
429}
430
b9e47e57
DM
431my $kill_process_group = sub {
432 my ($pid, $pstart) = @_;
433
434 # send kill to process group (negative pid)
435 my $kpid = -$pid;
436
437 # always send signal to all pgrp members
438 kill(15, $kpid); # send TERM signal
439
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);
443 sleep (1);
444 }
445
446 # to be sure
447 kill(9, $kpid);
448};
449
450sub check_worker {
451 my ($upid, $killit) = @_;
452
453 my $task = PVE::Tools::upid_decode($upid);
454
455 my $running = PVE::ProcFSTools::check_process_running($task->{pid}, $task->{pstart});
456
457 return 0 if !$running;
458
459 if ($killit) {
460 &$kill_process_group($task->{pid});
461 return 0;
462 }
463
464 return 1;
465}
466
2c3a6c0a
DM
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')
471sub fork_worker {
472 my ($self, $dtype, $id, $user, $function) = @_;
473
474 $dtype = 'unknown' if !defined ($dtype);
475 $id = '' if !defined ($id);
476
477 $user = 'root@pve' if !defined ($user);
478
479 my $sync = $self->{type} eq 'cli' ? 1 : 0;
480
481 local $SIG{INT} =
482 local $SIG{QUIT} =
483 local $SIG{PIPE} =
484 local $SIG{TERM} = 'IGNORE';
485
486 my $starttime = time ();
487
488 my @psync = POSIX::pipe();
489 my @csync = POSIX::pipe();
490
491 my $node = $self->{nodename};
492
493 my $cpid = fork();
494 die "unable to fork worker - $!" if !defined($cpid);
495
496 my $workerpuid = $cpid ? $cpid : $$;
497
498 my $pstart = PVE::ProcFSTools::read_proc_starttime($workerpuid) ||
499 die "unable to read process start time";
500
501 my $upid = PVE::Tools::upid_encode ({
502 node => $node, pid => $workerpuid, pstart => $pstart,
503 starttime => $starttime, type => $dtype, id => $id, user => $user });
504
505 my $outfh;
506
507 if (!$cpid) { # child
508
509 $0 = "task $upid";
510
511 $SIG{INT} = $SIG{QUIT} = $SIG{TERM} = sub { die "received interrupt\n"; };
512
513 $SIG{CHLD} = $SIG{PIPE} = 'DEFAULT';
514
515 # set sess/process group - we want to be able to kill the
516 # whole process group
517 POSIX::setsid();
518
519 POSIX::close ($psync[0]);
520 POSIX::close ($csync[1]);
521
522 $outfh = $sync ? $psync[1] : undef;
523
524 eval {
525 PVE::INotify::inotify_close();
526
527 if (my $atfork = $self->{atfork}) {
528 &$atfork();
529 }
530
531 # same algorythm as used inside SA
532 # STDIN = /dev/null
533 my $fd = fileno (STDIN);
2c3a6c0a 534
5a941ebe
DM
535 if (!$sync) {
536 close STDIN;
537 POSIX::close(0) if $fd != 0;
538
539 die "unable to redirect STDIN - $!"
540 if !open(STDIN, "</dev/null");
541
542 $outfh = PVE::Tools::upid_open($upid);
543 }
2c3a6c0a 544
2c3a6c0a
DM
545
546 # redirect STDOUT
547 $fd = fileno(STDOUT);
548 close STDOUT;
549 POSIX::close (1) if $fd != 1;
550
551 die "unable to redirect STDOUT - $!"
552 if !open(STDOUT, ">&", $outfh);
553
554 STDOUT->autoflush (1);
555
556 # redirect STDERR to STDOUT
557 $fd = fileno (STDERR);
558 close STDERR;
559 POSIX::close(2) if $fd != 2;
560
561 die "unable to redirect STDERR - $!"
562 if !open(STDERR, ">&1");
563
564 STDERR->autoflush(1);
565 };
566 if (my $err = $@) {
567 my $msg = "ERROR: $err";
568 POSIX::write($psync[1], $msg, length ($msg));
569 POSIX::close($psync[1]);
570 POSIX::_exit(1);
b9e47e57 571 kill(-9, $$);
2c3a6c0a
DM
572 }
573
f6f2d51f 574 # sync with parent (signal that we are ready)
2c3a6c0a
DM
575 if ($sync) {
576 print "$upid\n";
577 } else {
578 POSIX::write($psync[1], $upid, length ($upid));
579 POSIX::close($psync[1]);
580 }
581
582 my $readbuf = '';
583 # sync with parent (wait until parent is ready)
584 POSIX::read($csync[0], $readbuf, 4096);
585 die "parent setup error\n" if $readbuf ne 'OK';
586
587 eval { &$function($upid); };
588 my $err = $@;
589 if ($err) {
590 chomp $err;
591 $err =~ s/\n/ /mg;
592 syslog('err', $err);
593 print STDERR "TASK ERROR: $err\n";
594 POSIX::_exit(-1);
595 } else {
596 print STDERR "TASK OK\n";
b9e47e57 597 POSIX::_exit(0);
2c3a6c0a 598 }
b9e47e57 599 kill(-9, $$);
2c3a6c0a
DM
600 }
601
602 # parent
603
604 POSIX::close ($psync[1]);
605 POSIX::close ($csync[0]);
606
607 my $readbuf = '';
608 # sync with child (wait until child starts)
609 POSIX::read($psync[0], $readbuf, 4096);
610
611 if (!$sync) {
612 POSIX::close($psync[0]);
613 &$register_worker($cpid, $user, $upid);
614 } else {
615 chomp $readbuf;
616 }
617
618 eval {
619 die "got no worker upid - start worker failed\n" if !$readbuf;
620
621 if ($readbuf =~ m/^ERROR:\s*(.+)$/m) {
622 die "starting worker failed: $1\n";
623 }
624
625 if ($readbuf ne $upid) {
626 die "got strange worker upid ('$readbuf' != '$upid') - start worker failed\n";
627 }
628
629 if ($sync) {
630 $outfh = PVE::Tools::upid_open($upid);
631 }
632 };
633 my $err = $@;
634
635 if (!$err) {
636 my $msg = 'OK';
637 POSIX::write($csync[1], $msg, length ($msg));
638 POSIX::close($csync[1]);
639
640 } else {
641 POSIX::close($csync[1]);
b9e47e57 642 kill(-9, $cpid); # make sure it gets killed
2c3a6c0a
DM
643 die $err;
644 }
645
646 PVE::Cluster::log_msg('info', $user, "starting task $upid");
647
5bf71a96 648 my $tlist = active_workers($upid, $sync);
2c3a6c0a
DM
649 PVE::Cluster::broadcast_tasklist($tlist);
650
651 my $res = 0;
652
653 if ($sync) {
654 my $count;
655 my $outbuf = '';
8d6e045f 656 my $int_count = 0;
2c3a6c0a 657 eval {
8d6e045f 658 local $SIG{INT} = local $SIG{QUIT} = local $SIG{TERM} = sub {
527b2e7a
DM
659 # always send signal to all pgrp members
660 my $kpid = -$cpid;
8d6e045f 661 if ($int_count < 3) {
527b2e7a 662 kill(15, $kpid); # send TERM signal
8d6e045f 663 } else {
527b2e7a 664 kill(9, $kpid); # send KILL signal
8d6e045f
DM
665 }
666 $int_count++;
667 };
2c3a6c0a
DM
668 local $SIG{PIPE} = sub { die "broken pipe\n"; };
669
8d6e045f
DM
670 while (1) {
671 if (!defined($count = POSIX::read($psync[0], $readbuf, 4096))) {
672 next if $! == EINTR;
673 last;
674 }
675 last if $count == 0; # eof
676
2c3a6c0a
DM
677 $outbuf .= $readbuf;
678 while ($outbuf =~ s/^(([^\010\r\n]*)(\r|\n|(\010)+|\r\n))//s) {
679 my $line = $1;
680 my $data = $2;
681 if ($data =~ m/^TASK OK$/) {
682 # skip
683 } elsif ($data =~ m/^TASK ERROR: (.+)$/) {
684 print STDERR "$1\n";
685 } else {
686 print $line;
687 }
688 if ($outfh) {
689 print $outfh $line;
f6f2d51f 690 $outfh->flush();
2c3a6c0a
DM
691 }
692 }
693 }
694 };
695 my $err = $@;
696
697 POSIX::close($psync[0]);
698
699 if ($outbuf) { # just to be sure
700 print $outbuf;
701 if ($outfh) {
702 print $outfh $outbuf;
703 }
704 }
705
706 if ($err) {
707 $err =~ s/\n/ /mg;
708 print STDERR "$err\n";
709 if ($outfh) {
710 print $outfh "TASK ERROR: $err\n";
711 }
2c3a6c0a
DM
712 }
713
b9e47e57
DM
714 &$kill_process_group($cpid, $pstart); # make sure it gets killed
715
2c3a6c0a
DM
716 close($outfh);
717
b9e47e57 718 waitpid($cpid, 0);
2c3a6c0a
DM
719 $res = $?;
720 &$log_task_result($upid, $user, $res);
721 }
722
723 return wantarray ? ($upid, $res) : $upid;
724}
725
7261;