]> git.proxmox.com Git - pmg-api.git/blobdiff - PMG/Utils.pm
fix bug #1625 - change default rule priorities
[pmg-api.git] / PMG / Utils.pm
index 998ce8ac1a58c75fe4663e91991314d0777676e7..aa0da54965d7a32675621fe5f39e49271bf9f362 100644 (file)
@@ -13,11 +13,19 @@ use File::Basename;
 use MIME::Words;
 use MIME::Parser;
 use Time::HiRes qw (gettimeofday);
+use Time::Local;
 use Xdgmime;
 use Data::Dumper;
+use Digest::SHA;
+use Digest::MD5;
 use Net::IP;
 use Socket;
+use RRDs;
+use Filesys::Df;
+use Encode;
+use HTML::Entities;
 
+use PVE::ProcFSTools;
 use PVE::Network;
 use PVE::Tools;
 use PVE::SafeSyslog;
@@ -26,12 +34,82 @@ use PMG::AtomicFile;
 use PMG::MailQueue;
 use PMG::SMTPPrinter;
 
-sub msgquote {
-    my $msg = shift || '';
-    $msg =~ s/%/%%/g;
-    return $msg;
+my $valid_pmg_realms = ['pam', 'pmg', 'quarantine'];
+
+PVE::JSONSchema::register_standard_option('realm', {
+    description => "Authentication domain ID",
+    type => 'string',
+    enum => $valid_pmg_realms,
+    maxLength => 32,
+});
+
+PVE::JSONSchema::register_standard_option('pmg-starttime', {
+    description => "Only consider entries newer than 'starttime' (unix epoch). Default is 'now - 1day'.",
+    type => 'integer',
+    minimum => 0,
+    optional => 1,
+});
+
+PVE::JSONSchema::register_standard_option('pmg-endtime', {
+    description => "Only consider entries older than 'endtime' (unix epoch). This is set to '<start> + 1day' by default.",
+    type => 'integer',
+    minimum => 1,
+    optional => 1,
+});
+
+PVE::JSONSchema::register_format('pmg-userid', \&verify_username);
+sub verify_username {
+    my ($username, $noerr) = @_;
+
+    $username = '' if !$username;
+    my $len = length($username);
+    if ($len < 3) {
+       die "user name '$username' is too short\n" if !$noerr;
+       return undef;
+    }
+    if ($len > 64) {
+       die "user name '$username' is too long ($len > 64)\n" if !$noerr;
+       return undef;
+    }
+
+    # we only allow a limited set of characters
+    # colon is not allowed, because we store usernames in
+    # colon separated lists)!
+    # slash is not allowed because it is used as pve API delimiter
+    # also see "man useradd"
+    my $realm_list = join('|', @$valid_pmg_realms);
+    if ($username =~ m!^([^\s:/]+)\@(${realm_list})$!) {
+       return wantarray ? ($username, $1, $2) : $username;
+    }
+
+    die "value '$username' does not look like a valid user name\n" if !$noerr;
+
+    return undef;
 }
 
+PVE::JSONSchema::register_standard_option('userid', {
+    description => "User ID",
+    type => 'string', format => 'pmg-userid',
+    minLength => 4,
+    maxLength => 64,
+});
+
+PVE::JSONSchema::register_standard_option('username', {
+    description => "Username (without realm)",
+    type => 'string',
+    pattern => '[^\s:\/\@]{3,60}',
+    minLength => 4,
+    maxLength => 64,
+});
+
+PVE::JSONSchema::register_standard_option('pmg-email-address', {
+    description => "Email Address (allow most characters).",
+    type => 'string',
+    pattern => '(?:|[^\s\/\@]+\@[^\s\/\@]+)',
+    maxLength => 512,
+    minLength => 3,
+});
+
 sub lastid {
     my ($dbh, $seq) = @_;
 
@@ -39,6 +117,15 @@ sub lastid {
        undef, undef, undef, undef, { sequence => $seq});
 }
 
+# quote all regex operators
+sub quote_regex {
+    my $val = shift;
+
+    $val =~ s/([\(\)\[\]\/\}\+\*\?\.\|\^\$\\])/\\$1/g;
+
+    return $val;
+}
+
 sub file_older_than {
     my ($filename, $lasttime) = @_;
 
@@ -251,7 +338,7 @@ sub analyze_virus {
 
 sub magic_mime_type_for_file {
     my ($filename) = @_;
-    
+
     # we do not use get_mime_type_for_file, because that considers
     # filename extensions - we only want magic type detection
 
@@ -260,7 +347,7 @@ sub magic_mime_type_for_file {
 
     my $ct = "application/octet-stream";
 
-    my $fh = IO::File->new("<$filename") || 
+    my $fh = IO::File->new("<$filename") ||
        die "unable to open file '$filename' - $!";
 
     my ($buf, $len);
@@ -268,9 +355,9 @@ sub magic_mime_type_for_file {
        $ct = xdg_mime_get_mime_type_for_data($buf, $len);
     }
     $fh->close();
-    
+
     die "unable to read file '$filename' - $!" if ($len < 0);
-    
+
     return $ct;
 }
 
@@ -415,21 +502,85 @@ sub find_local_network_for_ip {
     die "unable to detect local network for ip '$ip'\n";
 }
 
+my $service_aliases = {
+    'postfix' =>  'postfix@-',
+    'postgres' => 'postgresql@9.6-main',
+};
+
+sub lookup_real_service_name {
+    my $alias = shift;
+
+    return $service_aliases->{$alias} // $alias;
+}
+
+sub get_full_service_state {
+    my ($service) = @_;
+
+    my $res;
+
+    my $parser = sub {
+       my $line = shift;
+       if ($line =~ m/^([^=\s]+)=(.*)$/) {
+           $res->{$1} = $2;
+       }
+    };
+
+    $service = $service_aliases->{$service} // $service;
+    PVE::Tools::run_command(['systemctl', 'show', $service], outfunc => $parser);
+
+    return $res;
+}
+
+our $db_service_list = [
+    'pmgpolicy', 'pmgmirror', 'pmgtunnel', 'pmg-smtp-filter' ];
+
+sub service_wait_stopped {
+    my ($timeout, $service_list) = @_;
+
+    my $starttime = time();
+
+    foreach my $service (@$service_list) {
+       PVE::Tools::run_command(['systemctl', 'stop', $service]);
+    }
+
+    while (1) {
+       my $wait = 0;
+
+       foreach my $service (@$service_list) {
+           my $ss = get_full_service_state($service);
+           my $state = $ss->{ActiveState} // 'unknown';
+
+           if ($state ne 'inactive') {
+               if ((time() - $starttime) > $timeout) {
+                   syslog('err', "unable to stop services (got timeout)");
+                   $wait = 0;
+                   last;
+               }
+               $wait = 1;
+           }
+       }
+
+       last if !$wait;
+
+       sleep(1);
+    }
+}
+
 sub service_cmd {
     my ($service, $cmd) = @_;
 
     die "unknown service command '$cmd'\n"
-       if $cmd !~ m/^(start|stop|restart|reload)$/;
+       if $cmd !~ m/^(start|stop|restart|reload|reload-or-restart)$/;
 
     if ($service eq 'pmgdaemon' || $service eq 'pmgproxy') {
-       if ($cmd eq 'restart') {
-           # OK
-       } else {
-           die "invalid service cmd '$service $cmd': ERROR";
-       }
+       die "invalid service cmd '$service $cmd': ERROR" if $cmd eq 'stop';
+    } elsif ($service eq 'fetchmail') {
+       # use restart instead of start - else it does not start 'exited' unit
+       # after setting START_DAEMON=yes in /etc/default/fetchmail
+       $cmd = 'restart' if $cmd eq 'start';
     }
 
-    $service = 'postfix@-' if $service eq 'postfix';
+    $service = $service_aliases->{$service} // $service;
     PVE::Tools::run_command(['systemctl', $cmd, $service]);
 };
 
@@ -465,6 +616,12 @@ sub run_postmap {
     # make sure the file exists (else postmap fails)
     IO::File->new($filename, 'a', 0644);
 
+    my $age_src = -M $filename // 0;
+    my $age_dst = -M "$filename.db" // 10000000000;
+
+    # if not changed, do nothing
+    return if $age_src > $age_dst;
+
     eval {
        PVE::Tools::run_command(
            ['/usr/sbin/postmap', $filename],
@@ -560,4 +717,465 @@ sub clamav_dbstat {
     return $res;
 }
 
+# RRD related code
+my $rrd_dir = "/var/lib/rrdcached/db";
+my $rrdcached_socket = "/var/run/rrdcached.sock";
+
+my $rrd_def_node = [
+    "DS:loadavg:GAUGE:120:0:U",
+    "DS:maxcpu:GAUGE:120:0:U",
+    "DS:cpu:GAUGE:120:0:U",
+    "DS:iowait:GAUGE:120:0:U",
+    "DS:memtotal:GAUGE:120:0:U",
+    "DS:memused:GAUGE:120:0:U",
+    "DS:swaptotal:GAUGE:120:0:U",
+    "DS:swapused:GAUGE:120:0:U",
+    "DS:roottotal:GAUGE:120:0:U",
+    "DS:rootused:GAUGE:120:0:U",
+    "DS:netin:DERIVE:120:0:U",
+    "DS:netout:DERIVE:120:0:U",
+
+    "RRA:AVERAGE:0.5:1:70", # 1 min avg - one hour
+    "RRA:AVERAGE:0.5:30:70", # 30 min avg - one day
+    "RRA:AVERAGE:0.5:180:70", # 3 hour avg - one week
+    "RRA:AVERAGE:0.5:720:70", # 12 hour avg - one month
+    "RRA:AVERAGE:0.5:10080:70", # 7 day avg - ony year
+
+    "RRA:MAX:0.5:1:70", # 1 min max - one hour
+    "RRA:MAX:0.5:30:70", # 30 min max - one day
+    "RRA:MAX:0.5:180:70", # 3 hour max - one week
+    "RRA:MAX:0.5:720:70", # 12 hour max - one month
+    "RRA:MAX:0.5:10080:70", # 7 day max - ony year
+];
+
+sub cond_create_rrd_file {
+    my ($filename, $rrddef) = @_;
+
+    return if -f $filename;
+
+    my @args = ($filename);
+
+    push @args, "--daemon" => "unix:${rrdcached_socket}"
+       if -S $rrdcached_socket;
+
+    push @args, '--step', 60;
+
+    push @args, @$rrddef;
+
+    # print "TEST: " . join(' ', @args) . "\n";
+
+    RRDs::create(@args);
+    my $err = RRDs::error;
+    die "RRD error: $err\n" if $err;
+}
+
+sub update_node_status_rrd {
+
+    my $filename = "$rrd_dir/pmg-node-v1.rrd";
+    cond_create_rrd_file($filename, $rrd_def_node);
+
+    my ($avg1, $avg5, $avg15) = PVE::ProcFSTools::read_loadavg();
+
+    my $stat = PVE::ProcFSTools::read_proc_stat();
+
+    my $netdev = PVE::ProcFSTools::read_proc_net_dev();
+
+    my ($uptime) = PVE::ProcFSTools::read_proc_uptime();
+
+    my $cpuinfo = PVE::ProcFSTools::read_cpuinfo();
+
+    my $maxcpu = $cpuinfo->{cpus};
+
+    # traffic from/to physical interface cards
+    my $netin = 0;
+    my $netout = 0;
+    foreach my $dev (keys %$netdev) {
+       next if $dev !~ m/^$PVE::Network::PHYSICAL_NIC_RE$/;
+       $netin += $netdev->{$dev}->{receive};
+       $netout += $netdev->{$dev}->{transmit};
+    }
+
+    my $meminfo = PVE::ProcFSTools::read_meminfo();
+
+    my $dinfo = df('/', 1); # output is bytes
+
+    my $ctime = time();
+
+    # everything not free is considered to be used
+    my $dused = $dinfo->{blocks} - $dinfo->{bfree};
+
+    my $data = "$ctime:$avg1:$maxcpu:$stat->{cpu}:$stat->{wait}:" .
+       "$meminfo->{memtotal}:$meminfo->{memused}:" .
+       "$meminfo->{swaptotal}:$meminfo->{swapused}:" .
+       "$dinfo->{blocks}:$dused:$netin:$netout";
+
+
+    my @args = ($filename);
+
+    push @args, "--daemon" => "unix:${rrdcached_socket}"
+       if -S $rrdcached_socket;
+
+    push @args, $data;
+
+    # print "TEST: " . join(' ', @args) . "\n";
+
+    RRDs::update(@args);
+    my $err = RRDs::error;
+    die "RRD error: $err\n" if $err;
+}
+
+sub create_rrd_data {
+    my ($rrdname, $timeframe, $cf) = @_;
+
+    my $rrd = "${rrd_dir}/$rrdname";
+
+    my $setup = {
+       hour =>  [ 60, 70 ],
+       day  =>  [ 60*30, 70 ],
+       week =>  [ 60*180, 70 ],
+       month => [ 60*720, 70 ],
+       year =>  [ 60*10080, 70 ],
+    };
+
+    my ($reso, $count) = @{$setup->{$timeframe}};
+    my $ctime  = $reso*int(time()/$reso);
+    my $req_start = $ctime - $reso*$count;
+
+    $cf = "AVERAGE" if !$cf;
+
+    my @args = (
+       "-s" => $req_start,
+       "-e" => $ctime - 1,
+       "-r" => $reso,
+       );
+
+    push @args, "--daemon" => "unix:${rrdcached_socket}"
+       if -S $rrdcached_socket;
+
+    my ($start, $step, $names, $data) = RRDs::fetch($rrd, $cf, @args);
+
+    my $err = RRDs::error;
+    die "RRD error: $err\n" if $err;
+
+    die "got wrong time resolution ($step != $reso)\n"
+       if $step != $reso;
+
+    my $res = [];
+    my $fields = scalar(@$names);
+    for my $line (@$data) {
+       my $entry = { 'time' => $start };
+       $start += $step;
+       for (my $i = 0; $i < $fields; $i++) {
+           my $name = $names->[$i];
+           if (defined(my $val = $line->[$i])) {
+               $entry->{$name} = $val;
+           } else {
+               # leave empty fields undefined
+               # maybe make this configurable?
+           }
+       }
+       push @$res, $entry;
+    }
+
+    return $res;
+}
+
+sub decode_to_html {
+    my ($charset, $data) = @_;
+
+    my $res = $data;
+
+    eval { $res = encode_entities(decode($charset, $data)); };
+
+    return $res;
+}
+
+sub decode_rfc1522 {
+    my ($enc) = @_;
+
+    my $res = '';
+
+    return '' if !$enc;
+
+    eval {
+       foreach my $r (MIME::Words::decode_mimewords($enc)) {
+           my ($d, $cs) = @$r;
+           if ($d) {
+               if ($cs) {
+                   $res .= decode($cs, $d);
+               } else {
+                   $res .= $d;
+               }
+           }
+       }
+    };
+
+    $res = $enc if $@;
+
+    return $res;
+}
+
+sub rfc1522_to_html {
+    my ($enc) = @_;
+
+    my $res = '';
+
+    return '' if !$enc;
+
+    eval {
+       foreach my $r (MIME::Words::decode_mimewords($enc)) {
+           my ($d, $cs) = @$r;
+           if ($d) {
+               if ($cs) {
+                   $res .= encode_entities(decode($cs, $d));
+               } else {
+                   $res .= encode_entities($d);
+               }
+           }
+       }
+    };
+
+    $res = $enc if $@;
+
+    return $res;
+}
+
+# RFC 2047 B-ENCODING http://rfc.net/rfc2047.html
+# (Q-Encoding is complex and error prone)
+sub bencode_header {
+    my $txt = shift;
+
+    my $CRLF = "\015\012";
+
+    # Nonprintables (controls + x7F + 8bit):
+    my $NONPRINT = "\\x00-\\x1F\\x7F-\\xFF";
+
+    # always use utf-8 (work with japanese character sets)
+    $txt = encode("UTF-8", $txt);
+
+    return $txt if $txt !~ /[$NONPRINT]/o;
+
+    my $res = '';
+
+    while ($txt =~ s/^(.{1,42})//sm) {
+       my $t = MIME::Words::encode_mimeword ($1, 'B', 'UTF-8');
+       $res .= $res ? "\015\012\t$t" : $t;
+    }
+
+    return $res;
+}
+
+sub load_sa_descriptions {
+    my ($additional_dirs) = @_;
+
+    my @dirs = ('/usr/share/spamassassin',
+               '/usr/share/spamassassin-extra');
+
+    push @dirs, @$additional_dirs if @$additional_dirs;
+
+    my $res = {};
+
+    my $parse_sa_file = sub {
+       my ($file) = @_;
+
+       open(my $fh,'<', $file);
+       return if !defined($fh);
+
+       while (defined(my $line = <$fh>)) {
+           if ($line =~ m/^describe\s+(\S+)\s+(.*)\s*$/) {
+               my ($name, $desc) = ($1, $2);
+               next if $res->{$name};
+               $res->{$name}->{desc} = $desc;
+               if ($desc =~ m|[\(\s](http:\/\/\S+\.[^\s\.\)]+\.[^\s\.\)]+)|i) {
+                   $res->{$name}->{url} = $1;
+               }
+           }
+       }
+       close($fh);
+    };
+
+    foreach my $dir (@dirs) {
+       foreach my $file (<$dir/*.cf>) {
+           $parse_sa_file->($file);
+       }
+    }
+
+    $res->{'ClamAVHeuristics'}->{desc} = "ClamAV heuristic tests";
+
+    return $res;
+}
+
+sub format_uptime {
+    my ($uptime) = @_;
+
+    my $days = int($uptime/86400);
+    $uptime -= $days*86400;
+
+    my $hours = int($uptime/3600);
+    $uptime -= $hours*3600;
+
+    my $mins = $uptime/60;
+
+    if ($days) {
+       my $ds = $days > 1 ? 'days' : 'day';
+       return sprintf "%d $ds %02d:%02d", $days, $hours, $mins;
+    } else {
+       return sprintf "%02d:%02d", $hours, $mins;
+    }
+}
+
+sub finalize_report {
+    my ($tt, $template, $data, $mailfrom, $receiver, $debug) = @_;
+
+    my $html = '';
+
+    $tt->process($template, $data, \$html) ||
+       die $tt->error() . "\n";
+
+    my $title;
+    if ($html =~ m|^\s*<title>(.*)</title>|m) {
+       $title = $1;
+    } else {
+       die "unable to extract template title\n";
+    }
+
+    my $top = MIME::Entity->build(
+       Type    => "multipart/related",
+       To      => $data->{pmail},
+       From    => $mailfrom,
+       Subject => bencode_header(decode_entities($title)));
+
+    $top->attach(
+       Data     => $html,
+       Type     => "text/html",
+       Encoding => $debug ? 'binary' : 'quoted-printable');
+
+    if ($debug) {
+       $top->print();
+       return;
+    }
+    # we use an empty envelope sender (we dont want to receive NDRs)
+    PMG::Utils::reinject_mail ($top, '', [$receiver], undef, $data->{fqdn});
+}
+
+sub lookup_timespan {
+    my ($timespan) = @_;
+
+    my (undef, undef, undef, $mday, $mon, $year) = localtime(time());
+    my $daystart = timelocal(0, 0, 0, $mday, $mon, $year);
+
+    my $start;
+    my $end;
+
+    if ($timespan eq 'today') {
+       $start = $daystart;
+       $end = $start + 86400;
+    } elsif ($timespan eq 'yesterday') {
+       $end = $daystart;
+       $start = $end - 86400;
+    } elsif ($timespan eq 'week') {
+       $end = $daystart;
+       $start = $end - 7*86400;
+    } else {
+       die "internal error";
+    }
+
+    return ($start, $end);
+}
+
+my $rbl_scan_last_cursor;
+my $rbl_scan_start_time = time();
+
+sub scan_journal_for_rbl_rejects {
+
+    # example postscreen log entry for RBL rejects
+    # Aug 29 08:00:36 proxmox postfix/postscreen[11266]: NOQUEUE: reject: RCPT from [x.x.x.x]:1234: 550 5.7.1 Service unavailable; client [x.x.x.x] blocked using zen.spamhaus.org; from=<xxxx>, to=<yyyy>, proto=ESMTP, helo=<zzz>
+
+    # example for PREGREET reject
+    # Dec  7 06:57:11 proxmox postfix/postscreen[32084]: PREGREET 14 after 0.23 from [x.x.x.x]:63492: EHLO yyyyy\r\n
+
+    my $identifier = 'postfix/postscreen';
+
+    my $rbl_count = 0;
+    my $pregreet_count = 0;
+
+    my $parser = sub {
+       my $line = shift;
+
+       if ($line =~ m/^--\scursor:\s(\S+)$/) {
+           $rbl_scan_last_cursor = $1;
+           return;
+       }
+
+       if ($line =~ m/\s$identifier\[\d+\]:\sNOQUEUE:\sreject:.*550 5.7.1 Service unavailable;/) {
+           $rbl_count++;
+       } elsif ($line =~ m/\s$identifier\[\d+\]:\sPREGREET\s\d+\safter\s/) {
+           $pregreet_count++;
+       }
+    };
+
+    # limit to last 5000 lines to avoid long delays
+    my $cmd = ['journalctl', '--show-cursor', '-o', 'short-unix', '--no-pager',
+              '--identifier', $identifier, '-n', 5000];
+
+    if (defined($rbl_scan_last_cursor)) {
+       push @$cmd, "--after-cursor=${rbl_scan_last_cursor}";
+    } else {
+       push @$cmd, "--since=@" . $rbl_scan_start_time;
+    }
+
+    PVE::Tools::run_command($cmd, outfunc => $parser);
+
+    return ($rbl_count, $pregreet_count);
+}
+
+my $hwaddress;
+
+sub get_hwaddress {
+
+    return $hwaddress if defined ($hwaddress);
+
+    my $fn = '/etc/ssh/ssh_host_rsa_key.pub';
+    my $sshkey = PVE::Tools::file_get_contents($fn);
+    $hwaddress = uc(Digest::MD5::md5_hex($sshkey));
+
+    return $hwaddress;
+}
+
+my $default_locale = "en_US.UTF-8 UTF-8";
+
+sub cond_add_default_locale {
+
+    my $filename = "/etc/locale.gen";
+
+    open(my $infh, "<", $filename) || return;
+
+    while (defined(my $line = <$infh>)) {
+       if ($line =~ m/^\Q${default_locale}\E/) {
+           # already configured
+           return;
+       }
+    }
+
+    seek($infh, 0, 0) // return; # seek failed
+
+    open(my $outfh, ">", "$filename.tmp") || return;
+
+    my $done;
+    while (defined(my $line = <$infh>)) {
+       if ($line =~ m/^#\s*\Q${default_locale}\E.*/) {
+           print $outfh "${default_locale}\n" if !$done;
+           $done = 1;
+       } else {
+           print $outfh $line;
+       }
+    }
+
+    print STDERR "generation pmg default locale\n";
+
+    rename("$filename.tmp", $filename) || return; # rename failed
+
+    system("dpkg-reconfigure locales -f noninteractive");
+}
+
 1;