]>
git.proxmox.com Git - pmg-api.git/blob - bin/pmgpolicy
6 use POSIX
qw(errno_h signal_h);
8 use Net
::Server
::PreForkSimple
;
9 use Net
::DNS
::Resolver
;
14 use Time
::HiRes
qw(gettimeofday);
25 use PMG
::ClusterConfig
;
27 use base
qw(Net::Server::PreForkSimple);
29 my $greylist_delay = 3*60; # greylist window
30 my $greylist_lifetime = 3600*24*2; # retry window
31 my $greylist_awlifetime = 3600*24*36; # expire window
33 my $opt_commandline = [$0, @ARGV];
34 my $opt_policy_port = 10022;
35 my $opt_max_dequeue = 1;
36 my $opt_dequeue_time = 60*2;
42 if (!GetOptions
('pidfile=s' => \
$opt_pidfile,
43 'testmode' => \
$opt_testmode,
44 'database=s' => \
$opt_database)) {
49 $opt_pidfile = "/var/run/pmgpolicy.pid" if !$opt_pidfile;
50 $opt_max_dequeue = 0 if $opt_testmode;
52 initlog
('pmgpolicy', 'mail');
58 my $pmg_cfg = PMG
::Config-
>new ();
59 my $demo = $pmg_cfg->get('admin', 'demo');
60 $max_servers = $pmg_cfg->get('mail', 'max_policy');
63 syslog
('info', 'demo mode detected - not starting server');
69 if (defined ($ENV{BOUND_SOCKETS
})) {
75 port
=> [ $opt_policy_port ],
77 max_servers
=> $max_servers,
78 max_dequeue
=> $opt_max_dequeue,
79 check_for_dequeue
=> $opt_dequeue_time,
81 pid_file
=> $opt_pidfile,
82 commandline
=> $opt_commandline,
83 no_close_by_child
=> 1,
88 if (defined($opt_database)) {
89 $database = $opt_database;
91 $database = "Proxmox_ruledb";
94 $SIG{'__WARN__'} = sub {
98 syslog
('warning', "WARNING: %s", $t);
105 $self->log(2, "starting greylist database maintainance");
107 my ($csec, $usec) = gettimeofday
();
109 my $cinfo = PVE
::INotify
::read_file
("cluster.conf");
110 my $lcid = $cinfo->{local}->{cid
};
111 my $role = $cinfo->{local}->{type
} // '-';
116 $dbh = PMG
::DBTools
::open_ruledb
($database);
121 $self->log(0, "ERROR: $err");
133 # we do not lock the table here to avoid delays
134 # but that is OK, because we only touch expired records
135 # which do not change nornmally
136 ## $dbh->do ("LOCK TABLE CGreylist IN ROW EXCLUSIVE MODE");
138 # move expired and undelivered records from Greylist to Statistic
142 $rntxt = "AND CID = 0";
144 if ($role eq 'master') {
145 # master is responsible for all non-cluster (deleted) nodes
146 foreach my $rcid (@{$cinfo->{remnodes
}}) {
147 $rntxt .= $rntxt ?
" AND CID != $rcid" : "AND (CID != $rcid";
149 $rntxt .= ")" if $rntxt;
151 $rntxt = "AND (CID = 0 OR CID = $lcid)";
158 my $sth = $dbh->prepare(
159 "SELECT distinct instance, sender FROM CGreylist " .
160 "WHERE passed = 0 AND extime < ? $rntxt");
162 $sth->execute ($now);
165 while (my $ref = $sth->fetchrow_hashref()) {
166 my $sth2 = $dbh->prepare(
167 "SELECT * FROM CGreylist WHERE instance = ? AND sender = ?");
168 $sth2->execute ($ref->{instance
}, $ref->{sender
});
173 while (my $ref2 = $sth2->fetchrow_hashref()) {
174 $rctime = $ref2->{rctime
} if !$rctime;
175 $bc += $ref2->{blocked
};
176 push @rcvrs, $ref2->{receiver
};
181 # hack: sometimes query sth2 does not return anything - maybe a
182 # postgres bug? We simply ignore (when rctime is undefined) it
186 $cmds .= "SELECT nextval ('cstatistic_id_seq');" .
187 "INSERT INTO CStatistic " .
188 "(CID, RID, ID, Time, Bytes, Direction, Spamlevel, VirusInfo, PTime, Sender) VALUES (" .
189 "$lcid, currval ('cstatistic_id_seq'), currval ('cstatistic_id_seq'), ";
191 my $sl = $bc >= 100000 ?
4 : 5;
192 $cmds .= $rctime . ", 0, '1', $sl, NULL, 0, ";
193 $cmds .= $dbh->quote ($ref->{sender
}) . ');';
195 foreach my $r (@rcvrs) {
196 my $tmp = $dbh->quote ($r);
197 $cmds .= "INSERT INTO CReceivers (CStatistic_CID, CStatistic_RID, Receiver, Blocked) ".
198 "VALUES ($lcid, currval ('cstatistic_id_seq'), $tmp, '1'); ";
202 if (length ($cmds) > 100000) {
209 # this produces too much log traffic
210 # my $targets = join (", ", @rcvrs);
211 #my $msg = "expire mail $ref->{instance} from $ref->{sender} to $targets";
212 #$self->log (0, $msg);
215 $dbh->do ($cmds) if $cmds;
220 my $msg = "found $ecount expired mails in greylisting database";
221 $self->log (0, $msg);
224 $dbh->do ("DELETE FROM CGreylist WHERE extime < $now");
231 my ($csec_end, $usec_end) = gettimeofday
();
232 my $ptime = int (($csec_end-$csec)*1000 + ($usec_end - $usec)/1000);
235 $dbh->rollback if $dbh;
238 $self->log(2, "end greylist database maintainance ($ptime ms)");
241 $dbh->disconnect() if $dbh;
247 my $prop = $self->{server
};
249 $prop->{log_level
} = 3;
251 $self->log(0, "Policy daemon (re)started");
254 # reloading server configuration
255 if (defined $prop->{children
}) {
256 foreach my $pid (keys %{$prop->{children
}}) {
257 kill(10, $pid); # SIGUSR1 childs
262 my $sig_set = POSIX
::SigSet-
>new;
263 $sig_set->addset (&POSIX
::SIGHUP
);
264 $sig_set->addset (&POSIX
::SIGCHLD
);
265 my $old_sig_set = POSIX
::SigSet-
>new();
267 sigprocmask
(SIG_UNBLOCK
, $sig_set, $old_sig_set);
273 my $prop = $self->{server
};
275 if ($self->{ruledb
}) {
276 $self->log(0, "reloading configuration $database");
277 $self->{ruledb
}->close();
280 my $pmg_cfg = PMG
::Config-
>new ();
281 $self->{use_spf
} = $pmg_cfg->get('mail', 'spf');
282 $self->{use_greylist
} = $pmg_cfg->get('mail', 'greylist');
285 $self->{use_spf
} = 1;
286 $self->{use_greylist
} = 1;
289 my $nodename = PVE
::INotify
::nodename
();
290 my $resolv = PVE
::INotify
::read_file
('resolvconf');
291 my $domain = $resolv->{search
};
292 $self->{fqdn
} = "$nodename.$domain";
294 my $cinfo = PVE
::INotify
::read_file
("cluster.conf");
295 my $lcid = $cinfo->{local}->{cid
};
296 $self->{cinfo
} = $cinfo;
297 $self->{lcid
} = $lcid;
302 $dbh = PMG
::DBTools
::open_ruledb
($database);
303 $self->{ruledb
} = PMG
::RuleDB-
>new($dbh);
304 $self->{rulecache
} = PMG
::RuleCache-
>new($self->{ruledb
});
307 $self->log(0, "ERROR: unable to load database : $err");
310 $self->{reload_config
} = 0;
313 sub child_init_hook
{
316 my $prop = $self->{server
};
318 $0 = 'pmgpolicy child';
320 setup_fork_signal_mask
(0); # unblocking signals for children
323 $self->load_config();
325 $self->{mux
} = IO
::Multiplex-
>new();
326 $self->{mux
}->set_callback_object($self);
338 # $dnsargs{nameservers} = [ qw (213.129.232.1 213.129.226.2) ];
341 $self->{dns_resolver
} = Net
::DNS
::Resolver-
>new(%dnsargs);
343 $self->{spf_server
} = Mail
::SPF
::Server-
>new(
344 hostname
=> $self->{fqdn
}, dns_resolver
=> $self->{dns_resolver
});
348 $self->child_finish_hook;
353 $self->{reload_config
} = 1;
357 sub child_finish_hook
{
360 my $prop = $self->{server
};
362 $self->{ruledb
}->close() if $self->{ruledb
};
366 my ($self, $instance, $ip, $helo, $sender) = @_;
373 # we only use helo tests when we have no sender,
374 # helo is sometimes empty, so we cant use SPF helo tests
375 # in that case - strange
376 if ($helo && !$sender) {
379 if (defined ($self->{cache
}->{$instance}) &&
380 defined ($self->{cache
}->{$instance}->{spf_helo_result
})) {
382 $query = $self->{cache
}->{$instance}->{spf_helo_result
};
385 my $request = Mail
::SPF
::Request-
>new(
386 scope
=> 'helo', identity
=> $helo, ip_address
=> $ip);
388 $query = $self->{cache
}->{$instance}->{spf_helo_result
} =
389 $self->{spf_server
}->process ($request);
392 $result = $query->code;
393 $spf_header = $query->received_spf_header;
394 $local_expl = $query->local_explanation;
395 $auth_expl = $query->authority_explanation if $query->is_code('fail');
397 # return if we get a definitive result
398 if ($result eq 'pass' || $result eq 'fail' || $result eq 'temperror') {
399 return ($result, $spf_header, $local_expl, $auth_expl);
407 if (defined ($self->{cache
}->{$instance}) &&
408 defined ($self->{cache
}->{$instance}->{spf_mfrom_result
})) {
410 $query = $self->{cache
}->{$instance}->{spf_mfrom_result
};
414 my $request = Mail
::SPF
::Request-
>new(
415 scope
=> 'mfrom', identity
=> $sender,
416 ip_address
=> $ip, helo_identity
=> $helo);
418 $query = $self->{cache
}->{$instance}->{spf_mfrom_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 ($result, $spf_header, $local_expl, $auth_expl);
434 my ($self, $ip, $receiver) = @_;
436 my ($rdomain) = $receiver =~ /([^@]+)$/;
438 my $dkey = "BKMX:$rdomain";
440 if (defined ($self->{cache
}->{$dkey}) &&
441 ($self->{cache
}->{$dkey}->{status
} == 1)) {
442 return $self->{cache
}->{$dkey}->{$ip};
445 my $resolver = $self->{dns_resolver
};
447 if (my $mx = $resolver->send($rdomain, 'MX')) {
448 $self->{cache
}->{$dkey}->{status
} = 1;
449 my @mxa = grep { $_->type eq 'MX' } $mx->answer;
450 my @mxl = sort { $a->preference <=> $b->preference } @mxa;
451 # shift @mxl; # optionaly skip primary MX ?
452 foreach my $rr (@mxl) {
453 my $a = $resolver->send ($rr->exchange, 'A');
455 foreach my $rra ($a->answer) {
456 if ($rra->type eq 'A') {
457 $self->{cache
}->{$dkey}->{$rra->address} = 1;
463 $self->{cache
}->{$dkey}->{status
} = 0;
466 return $self->{cache
}->{$dkey}->{$ip};
470 my ($self, $ctime, $helo, $ip, $sender, $rcpt, $instance) = @_;
472 my $rulecache = $self->{rulecache
};
474 my $dbh = $self->{ruledb
}->{dbh
};
476 # try to reconnect if database connection is broken
478 $self->log(0, 'Database connection broken - trying to reconnect');
481 $dbh = PMG
::DBTools
::open_ruledb
($database);
485 $self->log(0, "unable to reconnect to database server: $err");
488 $self->{ruledb
} = PMG
::RuleDB-
>new($dbh);
491 # some sender substitutions
492 my ($user, $domain) = split('@', $sender, 2);
493 if (defined ($user) && defined ($domain)) {
494 # see http://cr.yp.to/proto/verp.txt
495 $user =~ s/\+.*//; # strip extensions (mailing-list VERP)
496 $user =~ s/\b\d+\b/#/g; #replace nubmers in VERP address
497 $sender = "$user\@$domain";
500 if ($self->is_backup_mx($ip, $rcpt)) {
501 $self->log(3, "accept mails from backup MX host - $ip");
505 # greylist exclusion (sender whitelist)
506 if ($rulecache->greylist_match ($sender, $ip)) {
507 $self->log(3, "accept mails from whitelist - $ip");
511 # greylist exclusion (receiver whitelist)
512 if ($rulecache->greylist_match_receiver ($rcpt)) {
513 $self->log(3, "accept mails to whitelist - <$rcpt>");
517 my ($net, $host) = $ip =~ m/(\d+\.\d+\.\d+)\.(\d+)/;
520 if ((!$opt_testmode && $self->{use_spf
}) ||
521 ($opt_testmode && ($rcpt =~ m/^testspf/))) {
530 my ($result, $smtp_comment, $header_comment);
533 $previous_alarm = alarm(10);
534 local $SIG{ALRM
} = sub { die "SPF timeout\n" };
536 ($result, $spf_header, $local_expl, $auth_expl) =
537 $self->get_spf_result($instance, $ip, $helo, $sender);
539 alarm(0); # avoid race condition
543 alarm($previous_alarm) if defined($previous_alarm);
546 $err = $err->text if UNIVERSAL
::isa
($err, 'Mail::SPF::Exception');
547 $self->log (0, $err);
550 if ($result && $result eq 'pass') {
551 $self->log(3, "SPF says $result");
552 $spf_result = $spf_header ?
"prepend $spf_header" : 'dunno';
555 if ($result && $result eq 'fail') {
556 $self->log(3, "SPF says $result");
557 $spf_result = "reject ${auth_expl}";
563 # try to avoid locks everywhere - we use merge instead of insert
564 #$dbh->do ("LOCK TABLE CGreylist IN ROW EXCLUSIVE MODE");
566 # check if there is already a record in the GL database
567 my $sth = $dbh->prepare(
568 "SELECT * FROM CGreylist " .
569 "where IPNet = ? AND Sender = ? AND Receiver = ?");
571 $sth->execute($net, $sender, $rcpt);
572 my $ref = $sth->fetchrow_hashref();
575 # else add an entry to the GL Database with short
576 # expiration time. run_dequeue() moves those entries into the statistic
577 # table later. We set 'blocked' to 100000 to identify those entries.
579 if (!defined($ref->{rctime
})) {
581 $dbh->do("SELECT merge_greylist(?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)", undef,
582 $net, $host, $sender, $rcpt, $instance,
583 $ctime, $ctime + 10, 0, 100000, 0, $ctime, $self->{lcid
});
595 return $spf_result if $spf_result;
599 my $res = $spf_header ?
"prepend $spf_header" : 'dunno';
601 return $res if !$self->{use_greylist
};
603 my $defer_res = "defer_if_permit Service is unavailable (try later)";
607 # we dont use alarm here, because it does not work with DBI
611 # try to avoid locks everywhere - we use merge instead of insert
612 #$dbh->do ("LOCK TABLE CGreylist IN ROW EXCLUSIVE MODE");
614 my $sth = $dbh->prepare(
615 "SELECT * FROM CGreylist " .
616 "where IPNet = ? AND Sender = ? AND Receiver = ?");
618 $sth->execute($net, $sender, $rcpt);
620 my $ref = $sth->fetchrow_hashref();
624 if (!defined($ref->{rctime
})) {
626 $dbh->do ("SELECT merge_greylist(?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)", undef,
627 $net, $host, $sender, $rcpt, $instance,
628 $ctime, $ctime + $greylist_lifetime, 0, 1, 0, $ctime, $self->{lcid
});
631 $self->log(3, "defer greylisted mail");
633 my $age = $ctime - $ref->{rctime
};
635 if ($age < $greylist_delay) {
636 # defer (resent within greylist_delay window)
638 $self->log(3, "defer greylisted mail");
639 $dbh->do("UPDATE CGreylist " .
640 "SET Blocked = Blocked + 1, Host = ?, MTime = ? " .
641 "WHERE IPNet = ? AND Sender = ? AND Receiver = ?", undef,
642 $host, $ctime, $net, $sender, $rcpt);
644 if ($ctime < $ref->{extime
}) {
645 # accept (not expired)
646 my $lifetime = $sender eq "" ?
0 : $greylist_awlifetime;
647 my $delay = $ref->{passed
} ?
"" : "Delay = $age, ";
648 $dbh->do("UPDATE CGreylist " .
649 "SET Passed = Passed + 1, $delay Host = ?, ExTime = ?, MTime = ? " .
650 "WHERE IPNet = ? AND Sender = ? AND Receiver = ?", undef,
651 $host, $ctime + $lifetime, $ctime, $net, $sender, $rcpt);
653 # defer (record is expired)
655 $dbh->do("UPDATE CGreylist " .
656 "SET Host = ?, RCTime = ?, ExTime = ?, MTime = ?, Instance = ?, " .
657 "Blocked = 1, Passed = 0 " .
658 "WHERE IPNet = ? AND Sender = ? AND Receiver = ?", undef,
659 $host, $ctime, $ctime + $greylist_lifetime, $ctime, $instance,
660 $net, $sender, $rcpt);
669 $self->log (0, $err);
675 # shutdown connections: we need this - else file handles are
676 # not closed and we run out of handles
678 my ($self, $mux, $fh) = @_;
680 $mux->shutdown($fh, 1);
684 my ($self, $mux, $fh, $dataref) = @_;
685 my $prop = $self->{server
};
690 $self->load_config() if $self->{reload_config
};
692 while ($$dataref =~ s/^([^\r\n]*)\r?\n//) {
694 next if !defined ($line);
696 if ($line =~ m/([^=]+)=(.*)/) {
697 $attribute->{substr($1, 0, 255)} = substr($2, 0, 255);
698 } elsif ($line eq '') {
703 die "undefined test time :ERROR" if !defined $attribute->{testtime
};
704 $ctime = $attribute->{testtime
};
707 if ($attribute->{instance
} && $attribute->{recipient
} &&
708 $attribute->{client_address
} && $attribute->{request
} &&
709 $attribute->{request
} eq 'smtpd_access_policy') {
713 $res = $self->greylist_value(
715 lc ($attribute->{helo_name
}),
716 lc ($attribute->{client_address
}),
717 lc ($attribute->{sender
}),
718 lc ($attribute->{recipient
}),
719 lc ($attribute->{instance
}));
726 print $fh "action=$res\n\n";
730 $self->log(0, "greylist policy protocol error - got '%s'", $line);
736 # remove remaining data, if any
737 if ($$dataref ne '') {
738 $self->log(0, "greylist policy protocol error - unused data '%s'", $$dataref);
742 $self->log(0, $err) if $err;
745 sub restart_close_hook
{
748 my $sig_set = POSIX
::SigSet-
>new;
749 $sig_set->addset(&POSIX
::SIGHUP
);
750 $sig_set->addset(&POSIX
::SIGCHLD
); # to avoid zombies
751 my $old_sig_set = POSIX
::SigSet-
>new();
753 sigprocmask
(SIG_BLOCK
, $sig_set, $old_sig_set);
756 sub pre_server_close_hook
{
759 my $prop = $self->{server
};
761 if (defined $prop->{_HUP
}) {
762 undef $prop->{pid_file_unlink
};
765 if (defined $prop->{children
}) {
766 foreach my $pid (keys %{$prop->{children
}}) {
767 kill(1, $pid); # HUP childs
771 # nicely shutdown childs (give them max 30 seconds to shut down)
772 my $previous_alarm = alarm(30);
774 local $SIG{ALRM
} = sub { die "Timed Out!\n" };
777 1 while ((($pid = waitpid(-1, 0)) > 0) || ($! == EINTR
));
779 alarm(0); # avoid race
781 alarm ($previous_alarm);
784 sub setup_fork_signal_mask
{
787 my $sig_set = POSIX
::SigSet-
>new;
788 $sig_set->addset(&POSIX
::SIGINT
);
789 $sig_set->addset(&POSIX
::SIGTERM
);
790 $sig_set->addset(&POSIX
::SIGQUIT
);
791 $sig_set->addset(&POSIX
::SIGHUP
);
792 my $old_sig_set = POSIX
::SigSet-
>new();
795 sigprocmask
(SIG_BLOCK
, $sig_set, $old_sig_set);
797 sigprocmask
(SIG_UNBLOCK
, $sig_set, $old_sig_set);
801 # subroutine to start up a specified number of children.
802 # We need to block signals until handlers are set up correctly.
803 # Else its possible that HUP occurs after fork, which triggers
804 # singal TERM at childs and calls server_close() instead of
805 # simply exit the child.
806 # Note: on server startup signals are setup to trigger
807 # asynchronously for a short period of time (in PreForkSimple]::loop,
808 # run_n_children is called before run_parent)
809 # Net::Server::PreFork does not have this problem, because it is using
810 # signal HUP stop children
814 my $prop = $self->{server
};
816 setup_fork_signal_mask
(1); # block signals
818 $self->SUPER::run_n_children
($n);
820 setup_fork_signal_mask
(0); # unblocking signals for parent
823 # test sig_hup with: for ((;;)) ;do kill -HUP `cat /var/run/pmgpolicy.pid`; done;
824 # wrapper to avoid multiple calls to sig_hup
828 my $prop = $self->{server
};
830 return if defined($prop->{_HUP
}); # do not call twice
832 $self->SUPER::sig_hup
();
835 ### child process which will accept on the port
839 my $prop = $self->{server
};
841 $self->log(4, "Child Preforked ($$)\n");
843 # set correct signal handlers before enabling signals again
844 $SIG{INT
} = $SIG{TERM
} = $SIG{QUIT
} = $SIG{HUP
} = sub {
845 $self->child_finish_hook;
849 delete $prop->{children
};
851 $self->child_init_hook;
855 my $sock = $prop->{sock
}->[0];
857 # make sure we got a good sock
858 if (!defined ($sock)){
859 $self->log(0, "ERROR: Received a bad socket");
863 # sometimes the socket is not usable, don't know why
864 my $flags = fcntl($sock, F_GETFL
, 0);
866 $self->log(0, "socket not ready - $!");
870 # cache is limited, because postfix does max. 100 queries
874 my $mux = $self->{mux
};
875 $mux->listen ($sock);
879 $self->log(0, "ERROR: $err");
882 $self->child_finish_hook;
896 my ($self, $level, $msg, @therest) = @_;
898 my $prop = $self->{server
};
900 return if $level =~ /^\d+$/ && $level > $prop->{log_level
};
902 $level = $syslog_map->{$level} || $level;
904 syslog
($level, $msg, @therest);
906 syslog
($level, $msg);
911 server
=> $server_attr,
914 $server->sig_chld(); # avoid zombies after restart
924 pmgpolicy - The Proxmox policy daemon
932 Documentation is available at www.proxmox.com