6 use POSIX
qw(errno_h signal_h);
8 use Net
::Server
::PreForkSimple
;
9 use Net
::DNS
::Resolver
;
14 use Time
::HiRes
qw(gettimeofday);
26 use PMG
::ClusterConfig
;
28 use base
qw(Net::Server::PreForkSimple);
30 my $greylist_delay = 3*60; # greylist window
31 my $greylist_lifetime = 3600*24*2; # retry window
32 my $greylist_awlifetime = 3600*24*36; # expire window
34 my $opt_commandline = [$0, @ARGV];
35 my $opt_policy_port = 10022;
36 my $opt_max_dequeue = 1;
37 my $opt_dequeue_time = 60*2;
43 if (!GetOptions
('pidfile=s' => \
$opt_pidfile,
44 'testmode' => \
$opt_testmode,
45 'database=s' => \
$opt_database)) {
50 $opt_pidfile = "/var/run/pmgpolicy.pid" if !$opt_pidfile;
51 $opt_max_dequeue = 0 if $opt_testmode;
53 initlog
('pmgpolicy', 'mail');
59 my $pmg_cfg = PMG
::Config-
>new ();
60 my $demo = $pmg_cfg->get('admin', 'demo');
61 $max_servers = $pmg_cfg->get('mail', 'max_policy');
64 syslog
('info', 'demo mode detected - not starting server');
70 if (defined ($ENV{BOUND_SOCKETS
})) {
76 port
=> [ $opt_policy_port ],
78 max_servers
=> $max_servers,
79 max_dequeue
=> $opt_max_dequeue,
80 check_for_dequeue
=> $opt_dequeue_time,
82 pid_file
=> $opt_pidfile,
83 commandline
=> $opt_commandline,
84 no_close_by_child
=> 1,
89 if (defined($opt_database)) {
90 $database = $opt_database;
92 $database = "Proxmox_ruledb";
95 $SIG{'__WARN__'} = sub {
99 syslog
('warning', "WARNING: %s", $t);
103 sub update_rbl_stats
{
104 my ($dbh, $lcid) = @_;
106 my $rblcount = PMG
::Utils
::scan_journal_for_rbl_rejects
();
107 return if !$rblcount;
109 my $timezone = tz_local_offset
();;
110 my $hour = int((time() + $timezone)/3600) * 3600;
112 my $sth = $dbh->prepare(
113 'INSERT INTO LocalStat (Time, RBLCount, CID, MTime) ' .
114 'VALUES (?, ?, ?, EXTRACT(EPOCH FROM now())) ' .
115 'ON CONFLICT (Time, CID) DO UPDATE SET ' .
116 'RBLCount = LocalStat.RBLCount + excluded.RBLCount, ' .
117 'MTime = excluded.MTime');
119 $sth->execute($hour, $rblcount, $lcid);
126 $self->log(2, "starting policy database maintainance (greylist, rbl)");
128 my $cinfo = PMG
::ClusterConfig-
>new();
129 my $lcid = $cinfo->{local}->{cid
};
130 my $role = $cinfo->{local}->{type
} // '-';
135 $dbh = PMG
::DBTools
::open_ruledb
($database);
140 $self->log(0, "ERROR: $err");
144 my ($csec, $usec) = gettimeofday
();
146 eval { update_rbl_stats
($dbh, $lcid); };
149 my ($csec_end, $usec_end) = gettimeofday
();
150 my $rbltime = int (($csec_end-$csec)*1000 + ($usec_end - $usec)/1000);
151 ($csec, $usec) = ($csec_end, $usec_end);
154 $self->log(0, "rbl update error: $err");
166 # we do not lock the table here to avoid delays
167 # but that is OK, because we only touch expired records
168 # which do not change nornmally
169 ## $dbh->do ("LOCK TABLE CGreylist IN ROW EXCLUSIVE MODE");
171 # move expired and undelivered records from Greylist to Statistic
175 $rntxt = "AND CID = 0";
177 if ($role eq 'master') {
178 # master is responsible for all non-cluster (deleted) nodes
179 foreach my $rcid (@{$cinfo->{remnodes
}}) {
180 $rntxt .= $rntxt ?
" AND CID != $rcid" : "AND (CID != $rcid";
182 $rntxt .= ")" if $rntxt;
184 $rntxt = "AND (CID = 0 OR CID = $lcid)";
191 my $sth = $dbh->prepare(
192 "SELECT distinct instance, sender FROM CGreylist " .
193 "WHERE passed = 0 AND extime < ? $rntxt");
195 $sth->execute ($now);
198 while (my $ref = $sth->fetchrow_hashref()) {
199 my $sth2 = $dbh->prepare(
200 "SELECT * FROM CGreylist WHERE instance = ? AND sender = ?");
201 $sth2->execute ($ref->{instance
}, $ref->{sender
});
206 while (my $ref2 = $sth2->fetchrow_hashref()) {
207 $rctime = $ref2->{rctime
} if !$rctime;
208 $bc += $ref2->{blocked
};
209 push @rcvrs, $ref2->{receiver
};
214 # hack: sometimes query sth2 does not return anything - maybe a
215 # postgres bug? We simply ignore (when rctime is undefined) it
219 $cmds .= "SELECT nextval ('cstatistic_id_seq');" .
220 "INSERT INTO CStatistic " .
221 "(CID, RID, ID, Time, Bytes, Direction, Spamlevel, VirusInfo, PTime, Sender) VALUES (" .
222 "$lcid, currval ('cstatistic_id_seq'), currval ('cstatistic_id_seq'), ";
224 my $sl = $bc >= 100000 ?
4 : 5;
225 $cmds .= $rctime . ", 0, '1', $sl, NULL, 0, ";
226 $cmds .= $dbh->quote ($ref->{sender
}) . ');';
228 foreach my $r (@rcvrs) {
229 my $tmp = $dbh->quote ($r);
230 $cmds .= "INSERT INTO CReceivers (CStatistic_CID, CStatistic_RID, Receiver, Blocked) ".
231 "VALUES ($lcid, currval ('cstatistic_id_seq'), $tmp, '1'); ";
235 if (length ($cmds) > 100000) {
242 # this produces too much log traffic
243 # my $targets = join (", ", @rcvrs);
244 #my $msg = "expire mail $ref->{instance} from $ref->{sender} to $targets";
245 #$self->log (0, $msg);
248 $dbh->do ($cmds) if $cmds;
253 my $msg = "found $ecount expired mails in greylisting database";
254 $self->log (0, $msg);
257 $dbh->do ("DELETE FROM CGreylist WHERE extime < $now");
263 ($csec_end, $usec_end) = gettimeofday
();
264 my $ptime = int (($csec_end-$csec)*1000 + ($usec_end - $usec)/1000);
267 $dbh->rollback if $dbh;
268 $self->log(0, "greylist database update error: $err");
271 $self->log(2, "end policy database maintainance ($rbltime ms, $ptime ms)");
273 $dbh->disconnect() if $dbh;
279 my $prop = $self->{server
};
281 $prop->{log_level
} = 3;
283 $self->log(0, "Policy daemon (re)started");
286 # reloading server configuration
287 if (defined $prop->{children
}) {
288 foreach my $pid (keys %{$prop->{children
}}) {
289 kill(10, $pid); # SIGUSR1 childs
294 my $sig_set = POSIX
::SigSet-
>new;
295 $sig_set->addset (&POSIX
::SIGHUP
);
296 $sig_set->addset (&POSIX
::SIGCHLD
);
297 my $old_sig_set = POSIX
::SigSet-
>new();
299 sigprocmask
(SIG_UNBLOCK
, $sig_set, $old_sig_set);
305 my $prop = $self->{server
};
307 if ($self->{ruledb
}) {
308 $self->log(0, "reloading configuration $database");
309 $self->{ruledb
}->close();
312 my $pmg_cfg = PMG
::Config-
>new ();
313 $self->{use_spf
} = $pmg_cfg->get('mail', 'spf');
314 $self->{use_greylist
} = $pmg_cfg->get('mail', 'greylist');
317 $self->{use_spf
} = 1;
318 $self->{use_greylist
} = 1;
321 my $nodename = PVE
::INotify
::nodename
();
322 $self->{fqdn
} = PVE
::Tools
::get_fqdn
($nodename);
324 my $cinfo = PMG
::ClusterConfig-
>new();
325 my $lcid = $cinfo->{local}->{cid
};
326 $self->{cinfo
} = $cinfo;
327 $self->{lcid
} = $lcid;
332 $dbh = PMG
::DBTools
::open_ruledb
($database);
333 $self->{ruledb
} = PMG
::RuleDB-
>new($dbh);
334 $self->{rulecache
} = PMG
::RuleCache-
>new($self->{ruledb
});
337 $self->log(0, "ERROR: unable to load database : $err");
340 $self->{reload_config
} = 0;
343 sub child_init_hook
{
346 my $prop = $self->{server
};
348 $0 = 'pmgpolicy child';
350 setup_fork_signal_mask
(0); # unblocking signals for children
353 $self->load_config();
355 $self->{mux
} = IO
::Multiplex-
>new();
356 $self->{mux
}->set_callback_object($self);
368 # $dnsargs{nameservers} = [ qw (213.129.232.1 213.129.226.2) ];
371 $self->{dns_resolver
} = Net
::DNS
::Resolver-
>new(%dnsargs);
373 $self->{spf_server
} = Mail
::SPF
::Server-
>new(
374 hostname
=> $self->{fqdn
}, dns_resolver
=> $self->{dns_resolver
});
378 $self->child_finish_hook;
383 $self->{reload_config
} = 1;
387 sub child_finish_hook
{
390 my $prop = $self->{server
};
392 $self->{ruledb
}->close() if $self->{ruledb
};
396 my ($self, $instance, $ip, $helo, $sender) = @_;
403 # we only use helo tests when we have no sender,
404 # helo is sometimes empty, so we cant use SPF helo tests
405 # in that case - strange
406 if ($helo && !$sender) {
409 if (defined ($self->{cache
}->{$instance}) &&
410 defined ($self->{cache
}->{$instance}->{spf_helo_result
})) {
412 $query = $self->{cache
}->{$instance}->{spf_helo_result
};
415 my $request = Mail
::SPF
::Request-
>new(
416 scope
=> 'helo', identity
=> $helo, ip_address
=> $ip);
418 $query = $self->{cache
}->{$instance}->{spf_helo_result
} =
419 $self->{spf_server
}->process ($request);
422 $result = $query->code;
423 $spf_header = $query->received_spf_header;
424 $local_expl = $query->local_explanation;
425 $auth_expl = $query->authority_explanation if $query->is_code('fail');
427 # return if we get a definitive result
428 if ($result eq 'pass' || $result eq 'fail' || $result eq 'temperror') {
429 return ($result, $spf_header, $local_expl, $auth_expl);
437 if (defined ($self->{cache
}->{$instance}) &&
438 defined ($self->{cache
}->{$instance}->{spf_mfrom_result
})) {
440 $query = $self->{cache
}->{$instance}->{spf_mfrom_result
};
444 my $request = Mail
::SPF
::Request-
>new(
445 scope
=> 'mfrom', identity
=> $sender,
446 ip_address
=> $ip, helo_identity
=> $helo);
448 $query = $self->{cache
}->{$instance}->{spf_mfrom_result
} =
449 $self->{spf_server
}->process($request);
452 $result = $query->code;
453 $spf_header = $query->received_spf_header;
454 $local_expl = $query->local_explanation;
455 $auth_expl = $query->authority_explanation if $query->is_code('fail');
457 return ($result, $spf_header, $local_expl, $auth_expl);
464 my ($self, $ip, $receiver) = @_;
466 my ($rdomain) = $receiver =~ /([^@]+)$/;
468 my $dkey = "BKMX:$rdomain";
470 if (defined ($self->{cache
}->{$dkey}) &&
471 ($self->{cache
}->{$dkey}->{status
} == 1)) {
472 return $self->{cache
}->{$dkey}->{$ip};
475 my $resolver = $self->{dns_resolver
};
477 if (my $mx = $resolver->send($rdomain, 'MX')) {
478 $self->{cache
}->{$dkey}->{status
} = 1;
479 my @mxa = grep { $_->type eq 'MX' } $mx->answer;
480 my @mxl = sort { $a->preference <=> $b->preference } @mxa;
481 # shift @mxl; # optionaly skip primary MX ?
482 foreach my $rr (@mxl) {
483 my $a = $resolver->send ($rr->exchange, 'A');
485 foreach my $rra ($a->answer) {
486 if ($rra->type eq 'A') {
487 $self->{cache
}->{$dkey}->{$rra->address} = 1;
493 $self->{cache
}->{$dkey}->{status
} = 0;
496 return $self->{cache
}->{$dkey}->{$ip};
500 my ($self, $ctime, $helo, $ip, $sender, $rcpt, $instance) = @_;
502 my $rulecache = $self->{rulecache
};
504 my $dbh = $self->{ruledb
}->{dbh
};
506 # try to reconnect if database connection is broken
508 $self->log(0, 'Database connection broken - trying to reconnect');
511 $dbh = PMG
::DBTools
::open_ruledb
($database);
515 $self->log(0, "unable to reconnect to database server: $err");
518 $self->{ruledb
} = PMG
::RuleDB-
>new($dbh);
521 # some sender substitutions
522 my ($user, $domain) = split('@', $sender, 2);
523 if (defined ($user) && defined ($domain)) {
524 # see http://cr.yp.to/proto/verp.txt
525 $user =~ s/\+.*//; # strip extensions (mailing-list VERP)
526 $user =~ s/\b\d+\b/#/g; #replace nubmers in VERP address
527 $sender = "$user\@$domain";
530 if ($self->is_backup_mx($ip, $rcpt)) {
531 $self->log(3, "accept mails from backup MX host - $ip");
535 # greylist exclusion (sender whitelist)
536 if ($rulecache->greylist_match ($sender, $ip)) {
537 $self->log(3, "accept mails from whitelist - $ip");
541 # greylist exclusion (receiver whitelist)
542 if ($rulecache->greylist_match_receiver ($rcpt)) {
543 $self->log(3, "accept mails to whitelist - <$rcpt>");
547 my ($net, $host) = $ip =~ m/(\d+\.\d+\.\d+)\.(\d+)/;
550 if ((!$opt_testmode && $self->{use_spf
}) ||
551 ($opt_testmode && ($rcpt =~ m/^testspf/))) {
560 my ($result, $smtp_comment, $header_comment);
563 $previous_alarm = alarm(10);
564 local $SIG{ALRM
} = sub { die "SPF timeout\n" };
566 ($result, $spf_header, $local_expl, $auth_expl) =
567 $self->get_spf_result($instance, $ip, $helo, $sender);
569 alarm(0); # avoid race condition
573 alarm($previous_alarm) if defined($previous_alarm);
576 $err = $err->text if UNIVERSAL
::isa
($err, 'Mail::SPF::Exception');
577 $self->log (0, $err);
580 if ($result && $result eq 'pass') {
581 $self->log(3, "SPF says $result");
582 $spf_result = $spf_header ?
"prepend $spf_header" : 'dunno';
585 if ($result && $result eq 'fail') {
586 $self->log(3, "SPF says $result");
587 $spf_result = "reject ${auth_expl}";
593 # try to avoid locks everywhere - we use merge instead of insert
594 #$dbh->do ("LOCK TABLE CGreylist IN ROW EXCLUSIVE MODE");
596 # check if there is already a record in the GL database
597 my $sth = $dbh->prepare(
598 "SELECT * FROM CGreylist " .
599 "where IPNet = ? AND Sender = ? AND Receiver = ?");
601 $sth->execute($net, $sender, $rcpt);
602 my $ref = $sth->fetchrow_hashref();
605 # else add an entry to the GL Database with short
606 # expiration time. run_dequeue() moves those entries into the statistic
607 # table later. We set 'blocked' to 100000 to identify those entries.
609 if (!defined($ref->{rctime
})) {
611 $dbh->do($PMG::DBTools
::cgreylist_merge_sql
, undef,
612 $net, $host, $sender, $rcpt, $instance,
613 $ctime, $ctime + 10, 0, 100000, 0, $ctime, $self->{lcid
});
625 return $spf_result if $spf_result;
629 my $res = $spf_header ?
"prepend $spf_header" : 'dunno';
631 return $res if !$self->{use_greylist
};
633 my $defer_res = "defer_if_permit Service is unavailable (try later)";
637 # we dont use alarm here, because it does not work with DBI
641 # try to avoid locks everywhere - we use merge instead of insert
642 #$dbh->do ("LOCK TABLE CGreylist IN ROW EXCLUSIVE MODE");
644 my $sth = $dbh->prepare(
645 "SELECT * FROM CGreylist " .
646 "where IPNet = ? AND Sender = ? AND Receiver = ?");
648 $sth->execute($net, $sender, $rcpt);
650 my $ref = $sth->fetchrow_hashref();
654 if (!defined($ref->{rctime
})) {
656 $dbh->do($PMG::DBTools
::cgreylist_merge_sql
, undef,
657 $net, $host, $sender, $rcpt, $instance,
658 $ctime, $ctime + $greylist_lifetime, 0, 1, 0, $ctime, $self->{lcid
});
661 $self->log(3, "defer greylisted mail");
663 my $age = $ctime - $ref->{rctime
};
665 if ($age < $greylist_delay) {
666 # defer (resent within greylist_delay window)
668 $self->log(3, "defer greylisted mail");
669 $dbh->do("UPDATE CGreylist " .
670 "SET Blocked = Blocked + 1, Host = ?, MTime = ? " .
671 "WHERE IPNet = ? AND Sender = ? AND Receiver = ?", undef,
672 $host, $ctime, $net, $sender, $rcpt);
674 if ($ctime < $ref->{extime
}) {
675 # accept (not expired)
676 my $lifetime = $sender eq "" ?
0 : $greylist_awlifetime;
677 my $delay = $ref->{passed
} ?
"" : "Delay = $age, ";
678 $dbh->do("UPDATE CGreylist " .
679 "SET Passed = Passed + 1, $delay Host = ?, ExTime = ?, MTime = ? " .
680 "WHERE IPNet = ? AND Sender = ? AND Receiver = ?", undef,
681 $host, $ctime + $lifetime, $ctime, $net, $sender, $rcpt);
683 # defer (record is expired)
685 $dbh->do("UPDATE CGreylist " .
686 "SET Host = ?, RCTime = ?, ExTime = ?, MTime = ?, Instance = ?, " .
687 "Blocked = 1, Passed = 0 " .
688 "WHERE IPNet = ? AND Sender = ? AND Receiver = ?", undef,
689 $host, $ctime, $ctime + $greylist_lifetime, $ctime, $instance,
690 $net, $sender, $rcpt);
699 $self->log (0, $err);
705 # shutdown connections: we need this - else file handles are
706 # not closed and we run out of handles
708 my ($self, $mux, $fh) = @_;
710 $mux->shutdown($fh, 1);
714 my ($self, $mux, $fh, $dataref) = @_;
715 my $prop = $self->{server
};
720 $self->load_config() if $self->{reload_config
};
722 while ($$dataref =~ s/^([^\r\n]*)\r?\n//) {
724 next if !defined ($line);
726 if ($line =~ m/([^=]+)=(.*)/) {
727 $attribute->{substr($1, 0, 255)} = substr($2, 0, 255);
728 } elsif ($line eq '') {
733 die "undefined test time :ERROR" if !defined $attribute->{testtime
};
734 $ctime = $attribute->{testtime
};
737 if ($attribute->{instance
} && $attribute->{recipient
} &&
738 $attribute->{client_address
} && $attribute->{request
} &&
739 $attribute->{request
} eq 'smtpd_access_policy') {
743 $res = $self->greylist_value(
745 lc ($attribute->{helo_name
}),
746 lc ($attribute->{client_address
}),
747 lc ($attribute->{sender
}),
748 lc ($attribute->{recipient
}),
749 lc ($attribute->{instance
}));
756 print $fh "action=$res\n\n";
760 $self->log(0, "greylist policy protocol error - got '%s'", $line);
766 # remove remaining data, if any
767 if ($$dataref ne '') {
768 $self->log(0, "greylist policy protocol error - unused data '%s'", $$dataref);
772 $self->log(0, $err) if $err;
775 sub restart_close_hook
{
778 my $sig_set = POSIX
::SigSet-
>new;
779 $sig_set->addset(&POSIX
::SIGHUP
);
780 $sig_set->addset(&POSIX
::SIGCHLD
); # to avoid zombies
781 my $old_sig_set = POSIX
::SigSet-
>new();
783 sigprocmask
(SIG_BLOCK
, $sig_set, $old_sig_set);
786 sub pre_server_close_hook
{
789 my $prop = $self->{server
};
791 if (defined $prop->{_HUP
}) {
792 undef $prop->{pid_file_unlink
};
795 if (defined $prop->{children
}) {
796 foreach my $pid (keys %{$prop->{children
}}) {
797 kill(1, $pid); # HUP childs
801 # nicely shutdown childs (give them max 30 seconds to shut down)
802 my $previous_alarm = alarm(30);
804 local $SIG{ALRM
} = sub { die "Timed Out!\n" };
807 1 while ((($pid = waitpid(-1, 0)) > 0) || ($! == EINTR
));
809 alarm(0); # avoid race
811 alarm ($previous_alarm);
814 sub setup_fork_signal_mask
{
817 my $sig_set = POSIX
::SigSet-
>new;
818 $sig_set->addset(&POSIX
::SIGINT
);
819 $sig_set->addset(&POSIX
::SIGTERM
);
820 $sig_set->addset(&POSIX
::SIGQUIT
);
821 $sig_set->addset(&POSIX
::SIGHUP
);
822 my $old_sig_set = POSIX
::SigSet-
>new();
825 sigprocmask
(SIG_BLOCK
, $sig_set, $old_sig_set);
827 sigprocmask
(SIG_UNBLOCK
, $sig_set, $old_sig_set);
831 # subroutine to start up a specified number of children.
832 # We need to block signals until handlers are set up correctly.
833 # Else its possible that HUP occurs after fork, which triggers
834 # singal TERM at childs and calls server_close() instead of
835 # simply exit the child.
836 # Note: on server startup signals are setup to trigger
837 # asynchronously for a short period of time (in PreForkSimple]::loop,
838 # run_n_children is called before run_parent)
839 # Net::Server::PreFork does not have this problem, because it is using
840 # signal HUP stop children
844 my $prop = $self->{server
};
846 setup_fork_signal_mask
(1); # block signals
848 $self->SUPER::run_n_children
($n);
850 setup_fork_signal_mask
(0); # unblocking signals for parent
853 # test sig_hup with: for ((;;)) ;do kill -HUP `cat /var/run/pmgpolicy.pid`; done;
854 # wrapper to avoid multiple calls to sig_hup
858 my $prop = $self->{server
};
860 return if defined($prop->{_HUP
}); # do not call twice
862 $self->SUPER::sig_hup
();
865 ### child process which will accept on the port
869 my $prop = $self->{server
};
871 $self->log(4, "Child Preforked ($$)\n");
873 # set correct signal handlers before enabling signals again
874 $SIG{INT
} = $SIG{TERM
} = $SIG{QUIT
} = $SIG{HUP
} = sub {
875 $self->child_finish_hook;
879 delete $prop->{children
};
881 $self->child_init_hook;
885 my $sock = $prop->{sock
}->[0];
887 # make sure we got a good sock
888 if (!defined ($sock)){
889 $self->log(0, "ERROR: Received a bad socket");
893 # sometimes the socket is not usable, don't know why
894 my $flags = fcntl($sock, F_GETFL
, 0);
896 $self->log(0, "socket not ready - $!");
900 # cache is limited, because postfix does max. 100 queries
904 my $mux = $self->{mux
};
905 $mux->listen ($sock);
909 $self->log(0, "ERROR: $err");
912 $self->child_finish_hook;
926 my ($self, $level, $msg, @therest) = @_;
928 my $prop = $self->{server
};
930 return if $level =~ /^\d+$/ && $level > $prop->{log_level
};
932 $level = $syslog_map->{$level} || $level;
934 syslog
($level, $msg, @therest);
936 syslog
($level, $msg);
941 server
=> $server_attr,
944 $server->sig_chld(); # avoid zombies after restart
954 pmgpolicy - The Proxmox policy daemon
962 Documentation is available at www.proxmox.com