use Text::ParseWords;
use String::ShellQuote;
use Time::HiRes qw(usleep gettimeofday tv_interval alarm);
-use Net::DBus qw(dbus_uint32 dbus_uint64);
-use Net::DBus::Callback;
-use Net::DBus::Reactor;
use Scalar::Util 'weaken';
+use Date::Format qw(time2str);
+
use PVE::Syscall;
# avoid warning when parsing long hex values with hex()
safe_print
trim
extract_param
+extract_sensitive_params
file_copy
+get_host_arch
O_PATH
O_TMPFILE
+AT_EMPTY_PATH
+AT_FDCWD
+CLONE_NEWNS
+CLONE_NEWUTS
+CLONE_NEWIPC
+CLONE_NEWUSER
+CLONE_NEWPID
+CLONE_NEWNET
);
my $pvelogdir = "/var/log/pve";
our $IPRE = "(?:$IPV4RE|$IPV6RE)";
+our $EMAIL_USER_RE = qr/[\w\+\-\~]+(\.[\w\+\-\~]+)*/;
+our $EMAIL_RE = qr/$EMAIL_USER_RE@[a-zA-Z0-9\-]+(\.[a-zA-Z0-9\-]+)*/;
+
use constant {CLONE_NEWNS => 0x00020000,
CLONE_NEWUTS => 0x04000000,
CLONE_NEWIPC => 0x08000000,
CLONE_NEWNET => 0x40000000};
use constant {O_PATH => 0x00200000,
+ O_CLOEXEC => 0x00080000,
O_TMPFILE => 0x00410000}; # This includes O_DIRECTORY
+use constant {AT_EMPTY_PATH => 0x1000,
+ AT_FDCWD => -100};
+
sub run_with_timeout {
my ($timeout, $code, @param) = @_;
sub safe_read_from {
my ($fh, $max, $oneline, $filename) = @_;
- $max = 32768 if !$max;
+ # pmxcfs file size limit
+ $max = 512*1024 if !$max;
my $subject = defined($filename) ? "file '$filename'" : 'input';
my $afterfork;
my $noerr;
my $keeplocale;
+ my $quiet;
eval {
$noerr = $param{$p};
} elsif ($p eq 'keeplocale') {
$keeplocale = $param{$p};
+ } elsif ($p eq 'quiet') {
+ $quiet = $param{$p};
} else {
die "got unknown parameter '$p' for run_command\n";
}
if ($h eq $reader) {
if ($outfunc || $logfunc) {
eval {
- $outlog .= $buf;
- while ($outlog =~ s/^([^\010\r\n]*)(\r|\n|(\010)+|\r\n)//s) {
- my $line = $1;
+ while ($buf =~ s/^([^\010\r\n]*)(?:\n|(?:\010)+|\r\n?)//) {
+ my $line = $outlog . $1;
+ $outlog = '';
&$outfunc($line) if $outfunc;
&$logfunc($line) if $logfunc;
}
+ $outlog .= $buf;
};
my $err = $@;
if ($err) {
waitpid ($pid, 0);
die $err;
}
- } else {
+ } elsif (!$quiet) {
print $buf;
*STDOUT->flush();
}
} elsif ($h eq $error) {
if ($errfunc || $logfunc) {
eval {
- $errlog .= $buf;
- while ($errlog =~ s/^([^\010\r\n]*)(\r|\n|(\010)+|\r\n)//s) {
- my $line = $1;
+ while ($buf =~ s/^([^\010\r\n]*)(?:\n|(?:\010)+|\r\n?)//) {
+ my $line = $errlog . $1;
+ $errlog = '';
&$errfunc($line) if $errfunc;
&$logfunc($line) if $logfunc;
}
+ $errlog .= $buf;
};
my $err = $@;
if ($err) {
waitpid ($pid, 0);
die $err;
}
- } else {
+ } elsif (!$quiet) {
print STDERR $buf;
*STDERR->flush();
}
}
sub split_list {
- my $listtxt = shift || '';
+ my $listtxt = shift // '';
return split (/\0/, $listtxt) if $listtxt =~ m/\0/;
return $tmpl if !$tmpl;
my $res = '';
- while ($tmpl =~ m/([^{]+)?({([^}]+)})?/g) {
+ while ($tmpl =~ m/([^{]+)?(\{([^}]+)\})?/g) {
$res .= $1 if $1;
$res .= ($data->{$3} || '-') if $2;
}
'pl' => ['Polish', 'pl', 'qwerty/pl.kmap.gz', 'pl', undef],
'pt' => ['Portuguese', 'pt', 'qwerty/pt-latin1.kmap.gz', 'pt', 'nodeadkeys'],
'pt-br' => ['Brazil-Portuguese', 'pt-br', 'qwerty/br-latin1.kmap.gz', 'br', 'nodeadkeys'],
- #'ru' => ['Russian', 'ru', 'qwerty/ru.kmap.gz', 'ru', undef], # dont know?
+ #'ru' => ['Russian', 'ru', 'qwerty/ru.kmap.gz', 'ru', undef], # don't know?
'si' => ['Slovenian', 'sl', 'qwertz/slovene.kmap.gz', 'si', undef],
'se' => ['Swedish', 'sv', 'qwerty/se-latin1.kmap.gz', 'se', 'nodeadkeys'],
#'th' => [],
return $res;
}
+# For extracting sensitive keys (e.g. password), to avoid writing them to www-data owned configs
+sub extract_sensitive_params :prototype($$$) {
+ my ($param, $sensitive_list, $delete_list) = @_;
+
+ my %delete = map { $_ => 1 } ($delete_list || [])->@*;
+
+ my $sensitive = {};
+ for my $opt (@$sensitive_list) {
+ # handle deletions as explicitly setting `undef`, so subs which only have $param but not
+ # $delete_list available can recognize them. Afterwards new values may override.
+ if (exists($delete{$opt})) {
+ $sensitive->{$opt} = undef;
+ }
+
+ if (defined(my $value = extract_param($param, $opt))) {
+ $sensitive->{$opt} = $value;
+ }
+ }
+
+ return $sensitive;
+}
+
# Note: we use this to wait until vncterm/spiceterm is ready
sub wait_for_vnc_port {
my ($port, $family, $timeout) = @_;
return next_unused_port(5900, 6000, $family, $address);
}
+sub spice_port_range {
+ return (61000, 61999);
+}
+
sub next_spice_port {
my ($family, $address) = @_;
- return next_unused_port(61000, 61099, $family, $address);
+ return next_unused_port(spice_port_range(), $family, $address);
+}
+
+sub must_stringify {
+ my ($value) = @_;
+ eval { $value = "$value" };
+ return "error turning value into a string: $@" if $@;
+ return $value;
}
# sigkill after $timeout a $sub running in a fork if it can't write a pipe
# avoid leaving a zombie if the parent gets interrupted
my $sig_received;
- local $SIG{INT} = sub { $sig_received++; };
my $child = fork();
if (!defined($child)) {
$pipe_out->flush();
};
if (my $err = $@) {
- print {$pipe_out} encode_json({ error => $err });
+ print {$pipe_out} encode_json({ error => must_stringify($err) });
$pipe_out->flush();
POSIX::_exit(1);
}
POSIX::_exit(0);
}
+ local $SIG{INT} = sub { $sig_received++; };
+ local $SIG{TERM} = sub {
+ $error //= "interrupted by unexpected signal\n";
+ kill('TERM', $child);
+ };
+
$pipe_out->reader();
my $readvalues = sub {
local $/ = undef;
- my $child_res = decode_json(scalar<$pipe_out>);
+ my $child_res = decode_json(readline_nointr($pipe_out));
$res = $child_res->{result};
$error = $child_res->{error};
};
sub df {
my ($path, $timeout) = @_;
- my $res = {
- total => 0,
- used => 0,
- avail => 0,
+ my $df = sub { return Filesys::Df::df($path, 1) };
+
+ my $res = eval { run_fork_with_timeout($timeout, $df) } // {};
+ warn $@ if $@;
+
+ # untaint, but be flexible: PB usage can result in scientific notation
+ my ($blocks, $used, $bavail) = map { defined($_) ? (/^([\d\.e\-+]+)$/) : 0 }
+ $res->@{qw(blocks used bavail)};
+
+ return {
+ total => $blocks,
+ used => $used,
+ avail => $bavail,
};
+}
- my $pipe = IO::Pipe->new();
- my $child = fork();
- if (!defined($child)) {
- warn "fork failed: $!\n";
- return $res;
- }
+sub du {
+ my ($path, $timeout) = @_;
- if (!$child) {
- $pipe->writer();
- eval {
- my $df = Filesys::Df::df($path, 1);
- print {$pipe} "$df->{blocks}\n$df->{used}\n$df->{bavail}\n"
- if defined($df);
- $pipe->close();
- };
- if (my $err = $@) {
- warn $err;
- POSIX::_exit(1);
- }
- POSIX::_exit(0);
- }
+ my $size;
- $pipe->reader();
+ $timeout //= 10;
- my $readvalues = sub {
- $res->{total} = int(((<$pipe> // 0) =~ /^(\d*)$/)[0]);
- $res->{used} = int(((<$pipe> // 0) =~ /^(\d*)$/)[0]);
- $res->{avail} = int(((<$pipe> // 0) =~ /^(\d*)$/)[0]);
- };
- eval {
- run_with_timeout($timeout, $readvalues);
+ my $parser = sub {
+ my $line = shift;
+
+ if ($line =~ m/^(\d+)\s+total$/) {
+ $size = $1;
+ }
};
- warn $@ if $@;
- $pipe->close();
- kill('KILL', $child);
- waitpid($child, 0);
- return $res;
+
+ run_command(['du', '-scb', $path], outfunc => $parser, timeout => $timeout);
+
+ return $size;
}
# UPID helper
sub getaddrinfo_all {
my ($hostname, @opts) = @_;
- my %hints = ( flags => AI_V4MAPPED | AI_ALL,
- @opts );
+ my %hints = (
+ flags => AI_V4MAPPED | AI_ALL,
+ @opts,
+ );
my ($err, @res) = Socket::getaddrinfo($hostname, '0', \%hints);
die "failed to get address info for: $hostname: $err\n" if $err;
return @res;
return; # nothing
}
+sub setresuid($$$) {
+ my ($ruid, $euid, $suid) = @_;
+ return 0 == syscall(PVE::Syscall::setresuid, $ruid, $euid, $suid);
+}
+
sub unshare($) {
my ($flags) = @_;
return 0 == syscall(PVE::Syscall::unshare, $flags);
return 0 == syscall(PVE::Syscall::syncfs, $fileno);
}
+sub fsync($) {
+ my ($fileno) = @_;
+ return 0 == syscall(PVE::Syscall::fsync, $fileno);
+}
+
sub sync_mountpoint {
my ($path) = @_;
- sysopen my $fd, $path, O_PATH or die "failed to open $path: $!\n";
- my $result = syncfs(fileno($fd));
+ sysopen my $fd, $path, O_RDONLY|O_CLOEXEC or die "failed to open $path: $!\n";
+ my $syncfs_err;
+ if (!syncfs(fileno($fd))) {
+ $syncfs_err = "$!";
+ }
close($fd);
- return $result;
+ die "syncfs '$path' failed - $syncfs_err\n" if defined $syncfs_err;
}
# support sending multi-part mail messages with a text and or a HTML part
# mailto may be a single email string or an array of receivers
sub sendmail {
my ($mailto, $subject, $text, $html, $mailfrom, $author) = @_;
- my $mail_re = qr/[^-a-zA-Z0-9+._@]/;
$mailto = [ $mailto ] if !ref($mailto);
- foreach (@$mailto) {
- die "illegal character in mailto address\n"
- if ($_ =~ $mail_re);
+ my $mailto_quoted = [];
+ for my $to (@$mailto) {
+ die "mailto does not look like a valid email address or username\n"
+ if $to !~ /^$EMAIL_RE$/ && $to !~ /^$EMAIL_USER_RE$/;
+ push @$mailto_quoted, shellquote($to);
}
my $rcvrtxt = join (', ', @$mailto);
$mailfrom = $mailfrom || "root";
- die "illegal character in mailfrom address\n"
- if $mailfrom =~ $mail_re;
+ die "mailfrom does not look like a valid email address or username\n"
+ if $mailfrom !~ /^$EMAIL_RE$/ && $mailfrom !~ /^$EMAIL_USER_RE$/;
+ my $mailfrom_quoted = shellquote($mailfrom);
- $author = $author || 'Proxmox VE';
+ $author = $author // 'Proxmox VE';
- open (MAIL, "|-", "sendmail", "-B", "8BITMIME", "-f", $mailfrom, @$mailto) ||
- die "unable to open 'sendmail' - $!";
+ open (MAIL, "|-", "sendmail", "-B", "8BITMIME", "-f", $mailfrom_quoted,
+ "--", @$mailto_quoted) || die "unable to open 'sendmail' - $!";
+
+ my $date = time2str('%a, %d %b %Y %H:%M:%S %z', time());
+
+ my $is_multipart = $text && $html;
# multipart spec see https://www.ietf.org/rfc/rfc1521.txt
my $boundary = "----_=_NextPart_001_".int(time).$$;
- print MAIL "Content-Type: multipart/alternative;\n";
- print MAIL "\tboundary=\"$boundary\"\n";
- print MAIL "MIME-Version: 1.0\n";
+ if ($subject =~ /[^[:ascii:]]/) {
+ $subject = Encode::encode('MIME-Header', $subject);
+ }
- print MAIL "FROM: $author <$mailfrom>\n";
- print MAIL "TO: $rcvrtxt\n";
- print MAIL "SUBJECT: $subject\n";
- print MAIL "\n";
- print MAIL "This is a multi-part message in MIME format.\n\n";
- print MAIL "--$boundary\n";
+ if ($subject =~ /[^[:ascii:]]/ || $is_multipart) {
+ print MAIL "MIME-Version: 1.0\n";
+ }
+ print MAIL "From: $author <$mailfrom>\n";
+ print MAIL "To: $rcvrtxt\n";
+ print MAIL "Date: $date\n";
+ print MAIL "Subject: $subject\n";
+
+ if ($is_multipart) {
+ print MAIL "Content-Type: multipart/alternative;\n";
+ print MAIL "\tboundary=\"$boundary\"\n";
+ print MAIL "\n";
+ print MAIL "This is a multi-part message in MIME format.\n\n";
+ print MAIL "--$boundary\n";
+ }
if (defined($text)) {
print MAIL "Content-Type: text/plain;\n";
- print MAIL "\tcharset=\"UTF8\"\n";
+ print MAIL "\tcharset=\"UTF-8\"\n";
print MAIL "Content-Transfer-Encoding: 8bit\n";
print MAIL "\n";
print MAIL $text;
- print MAIL "\n--$boundary\n";
+ print MAIL "\n--$boundary\n" if $is_multipart;
}
if (defined($html)) {
print MAIL "Content-Type: text/html;\n";
- print MAIL "\tcharset=\"UTF8\"\n";
+ print MAIL "\tcharset=\"UTF-8\"\n";
print MAIL "Content-Transfer-Encoding: 8bit\n";
print MAIL "\n";
print MAIL $html;
- print MAIL "\n--$boundary--\n";
+ print MAIL "\n--$boundary--\n" if $is_multipart;
}
close(MAIL);
return syscall(PVE::Syscall::mkdirat, $dirfd, $name, $mode) == 0;
}
-# NOTE: This calls the dbus main loop and must not be used when another dbus
-# main loop is being used as we need to wait for the JobRemoved signal.
-# Polling the job status instead doesn't work because this doesn't give us the
-# distinction between success and failure.
-#
-# Note that the description is mandatory for security reasons.
-sub enter_systemd_scope {
- my ($unit, $description, %extra) = @_;
- die "missing description\n" if !defined($description);
-
- my $timeout = delete $extra{timeout};
-
- $unit .= '.scope';
- my $properties = [ [PIDs => [dbus_uint32($$)]] ];
-
- foreach my $key (keys %extra) {
- if ($key eq 'Slice' || $key eq 'KillMode') {
- push @$properties, [$key, $extra{$key}];
- } elsif ($key eq 'CPUShares') {
- push @$properties, [$key, dbus_uint64($extra{$key})];
- } elsif ($key eq 'CPUQuota') {
- push @$properties, ['CPUQuotaPerSecUSec',
- dbus_uint64($extra{$key} * 10000)];
- } else {
- die "Don't know how to encode $key for systemd scope\n";
- }
- }
-
- my $job;
- my $done = 0;
-
- my $bus = Net::DBus->system();
- my $reactor = Net::DBus::Reactor->main();
-
- my $service = $bus->get_service('org.freedesktop.systemd1');
- my $if = $service->get_object('/org/freedesktop/systemd1', 'org.freedesktop.systemd1.Manager');
- # Connect to the JobRemoved signal since we want to wait for it to finish
- my $sigid;
- my $timer;
- my $cleanup = sub {
- my ($no_shutdown) = @_;
- $if->disconnect_from_signal('JobRemoved', $sigid) if defined($if);
- $if = undef;
- $sigid = undef;
- $reactor->remove_timeout($timer) if defined($timer);
- $timer = undef;
- return if $no_shutdown;
- $reactor->shutdown();
- };
-
- $sigid = $if->connect_to_signal('JobRemoved', sub {
- my ($id, $removed_job, $signaled_unit, $result) = @_;
- return if $signaled_unit ne $unit || $removed_job ne $job;
- $cleanup->(0);
- die "systemd job failed\n" if $result ne 'done';
- $done = 1;
- });
-
- my $on_timeout = sub {
- $cleanup->(0);
- die "systemd job timed out\n";
- };
-
- $timer = $reactor->add_timeout($timeout * 1000, Net::DBus::Callback->new(method => $on_timeout))
- if defined($timeout);
- $job = $if->StartTransientUnit($unit, 'fail', $properties, []);
- $reactor->run();
- $cleanup->(1);
- die "systemd job never completed\n" if !$done;
+sub fchownat($$$$$) {
+ my ($dirfd, $pathname, $owner, $group, $flags) = @_;
+ return syscall(PVE::Syscall::fchownat, $dirfd, $pathname, $owner, $group, $flags) == 0;
}
my $salt_starter = time();
}
# intended usage: convert_size($val, "kb" => "gb")
-# on reduction (converting to a bigger unit) we round up by default if
-# information got lost. E.g. `convert_size(1023, "b" => "kb")` returns 1
+# we round up to the next integer by default
+# E.g. `convert_size(1023, "b" => "kb")` returns 1
# use $no_round_up to switch this off, above example would then return 0
+# this is also true for converting down e.g. 0.0005 gb to mb returns 1
+# (0 if $no_round_up is true)
+# allowed formats for value:
+# 1234
+# 1234.
+# 1234.1234
+# .1234
sub convert_size {
my ($value, $from, $to, $no_round_up) = @_;
pb => 5,
};
- $from = lc($from); $to = lc($to);
+ die "no value given"
+ if !defined($value) || $value eq "";
+
+ $from = lc($from // ''); $to = lc($to // '');
die "unknown 'from' and/or 'to' units ($from => $to)"
- if !(defined($units->{$from}) && defined($units->{$to}));
+ if !defined($units->{$from}) || !defined($units->{$to});
+
+ die "value '$value' is not a valid, positive number"
+ if $value !~ m/^(?:[0-9]+\.?[0-9]*|[0-9]*\.[0-9]+)$/;
- my $shift_amount = $units->{$from} - $units->{$to};
+ my $shift_amount = ($units->{$from} - $units->{$to}) * 10;
- if ($shift_amount > 0) {
- $value <<= ($shift_amount * 10);
- } elsif ($shift_amount < 0) {
- my $remainder = ($value & (1 << abs($shift_amount)*10) - 1);
- $value >>= abs($shift_amount) * 10;
- $value++ if $remainder && !$no_round_up;
+ $value *= 2**$shift_amount;
+ $value++ if !$no_round_up && ($value - int($value)) > 0.0;
+
+ return int($value);
+}
+
+# uninterruptible readline
+# retries on EINTR
+sub readline_nointr {
+ my ($fh) = @_;
+ my $line;
+ while (1) {
+ $line = <$fh>;
+ last if defined($line) || ($! != EINTR);
}
+ return $line;
+}
+
+my $host_arch;
+sub get_host_arch {
+ $host_arch = (POSIX::uname())[4] if !$host_arch;
+ return $host_arch;
+}
+
+# Devices are: [ (12 bits minor) (12 bits major) (8 bits minor) ]
+sub dev_t_major($) {
+ my ($dev_t) = @_;
+ return (int($dev_t) & 0xfff00) >> 8;
+}
+
+sub dev_t_minor($) {
+ my ($dev_t) = @_;
+ $dev_t = int($dev_t);
+ return (($dev_t >> 12) & 0xfff00) | ($dev_t & 0xff);
+}
+
+# Given an array of array refs [ \[a b c], \[a b b], \[e b a] ]
+# Returns the intersection of elements as a single array [a b]
+sub array_intersect {
+ my ($arrays) = @_;
+
+ if (!ref($arrays->[0])) {
+ $arrays = [ grep { ref($_) eq 'ARRAY' } @_ ];
+ }
+
+ return [] if scalar(@$arrays) == 0;
+ return $arrays->[0] if scalar(@$arrays) == 1;
+
+ my $array_unique = sub {
+ my %seen = ();
+ return grep { ! $seen{ $_ }++ } @_;
+ };
+
+ # base idea is to get all unique members from the first array, then
+ # check the common elements with the next (uniquely made) one, only keep
+ # those. Repeat for every array and at the end we only have those left
+ # which exist in all arrays
+ my $return_arr = [ $array_unique->(@{$arrays->[0]}) ];
+ for my $i (1 .. $#$arrays) {
+ my %count = ();
+ # $return_arr is already unique, explicit at before the loop, implicit below.
+ foreach my $element (@$return_arr, $array_unique->(@{$arrays->[$i]})) {
+ $count{$element}++;
+ }
+ $return_arr = [];
+ foreach my $element (keys %count) {
+ push @$return_arr, $element if $count{$element} > 1;
+ }
+ last if scalar(@$return_arr) == 0; # empty intersection, early exit
+ }
+
+ return $return_arr;
+}
+
+sub open_tree($$$) {
+ my ($dfd, $pathname, $flags) = @_;
+ return PVE::Syscall::file_handle_result(syscall(
+ &PVE::Syscall::open_tree,
+ $dfd,
+ $pathname,
+ $flags,
+ ));
+}
+
+sub move_mount($$$$$) {
+ my ($from_dirfd, $from_pathname, $to_dirfd, $to_pathname, $flags) = @_;
+ return 0 == syscall(
+ &PVE::Syscall::move_mount,
+ $from_dirfd,
+ $from_pathname,
+ $to_dirfd,
+ $to_pathname,
+ $flags,
+ );
+}
+
+sub fsopen($$) {
+ my ($fsname, $flags) = @_;
+ return PVE::Syscall::file_handle_result(syscall(&PVE::Syscall::fsopen, $fsname, $flags));
+}
+
+sub fsmount($$$) {
+ my ($fd, $flags, $mount_attrs) = @_;
+ return PVE::Syscall::file_handle_result(syscall(
+ &PVE::Syscall::fsmount,
+ $fd,
+ $flags,
+ $mount_attrs,
+ ));
+}
+
+sub fspick($$$) {
+ my ($dirfd, $pathname, $flags) = @_;
+ return PVE::Syscall::file_handle_result(syscall(
+ &PVE::Syscall::fspick,
+ $dirfd,
+ $pathname,
+ $flags,
+ ));
+}
+
+sub fsconfig($$$$$) {
+ my ($fd, $command, $key, $value, $aux) = @_;
+ return 0 == syscall(&PVE::Syscall::fsconfig, $fd, $command, $key, $value, $aux);
+}
+
+# "raw" mount, old api, not for generic use (as it does not invoke any helpers).
+# use for lower level stuff such as bind/remount/... or simple tmpfs mounts
+sub mount($$$$$) {
+ my ($source, $target, $filesystemtype, $mountflags, $data) = @_;
+ return 0 == syscall(
+ &PVE::Syscall::mount,
+ $source,
+ $target,
+ $filesystemtype,
+ $mountflags,
+ $data,
+ );
+}
+
+sub safe_compare {
+ my ($left, $right, $cmp) = @_;
- return $value;
+ return 0 if !defined($left) && !defined($right);
+ return -1 if !defined($left);
+ return 1 if !defined($right);
+ return $cmp->($left, $right);
}
1;