/usr/share/perl5/Mail/SpamAssassin/Plugin/Pyzor.pm is in spamassassin 3.4.1-8build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 | # <@LICENSE>
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to you under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with
# the License. You may obtain a copy of the License at:
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# </@LICENSE>
=head1 NAME
Mail::SpamAssassin::Plugin::Pyzor - perform Pyzor check of messages
=head1 SYNOPSIS
loadplugin Mail::SpamAssassin::Plugin::Pyzor
=head1 DESCRIPTION
Pyzor is a collaborative, networked system to detect and block spam
using identifying digests of messages.
See http://pyzor.sourceforge.net/ for more information about Pyzor.
=cut
package Mail::SpamAssassin::Plugin::Pyzor;
use Mail::SpamAssassin::Plugin;
use Mail::SpamAssassin::Logger;
use Mail::SpamAssassin::Timeout;
use Mail::SpamAssassin::Util qw(untaint_var untaint_file_path
proc_status_ok exit_status_str);
use strict;
use warnings;
use bytes;
use re 'taint';
use vars qw(@ISA);
@ISA = qw(Mail::SpamAssassin::Plugin);
sub new {
my $class = shift;
my $mailsaobject = shift;
$class = ref($class) || $class;
my $self = $class->SUPER::new($mailsaobject);
bless ($self, $class);
# are network tests enabled?
if ($mailsaobject->{local_tests_only}) {
$self->{pyzor_available} = 0;
dbg("pyzor: local tests only, disabling Pyzor");
}
else {
$self->{pyzor_available} = 1;
dbg("pyzor: network tests on, attempting Pyzor");
}
$self->register_eval_rule("check_pyzor");
$self->set_config($mailsaobject->{conf});
return $self;
}
sub set_config {
my ($self, $conf) = @_;
my @cmds;
=head1 USER OPTIONS
=over 4
=item use_pyzor (0|1) (default: 1)
Whether to use Pyzor, if it is available.
=cut
push (@cmds, {
setting => 'use_pyzor',
default => 1,
type => $Mail::SpamAssassin::Conf::CONF_TYPE_BOOL
});
=item pyzor_max NUMBER (default: 5)
This option sets how often a message's body checksum must have been
reported to the Pyzor server before SpamAssassin will consider the Pyzor
check as matched.
As most clients should not be auto-reporting these checksums, you should
set this to a relatively low value, e.g. C<5>.
=cut
push (@cmds, {
setting => 'pyzor_max',
default => 5,
type => $Mail::SpamAssassin::Conf::CONF_TYPE_NUMERIC
});
=back
=head1 ADMINISTRATOR OPTIONS
=over 4
=item pyzor_timeout n (default: 3.5)
How many seconds you wait for Pyzor to complete, before scanning continues
without the Pyzor results. A numeric value is optionally suffixed by a
time unit (s, m, h, d, w, indicating seconds (default), minutes, hours,
days, weeks).
You can configure Pyzor to have its own per-server timeout. Set this
plugin's timeout with that in mind. This plugin's timeout is a maximum
ceiling. If Pyzor takes longer than this to complete its communication
with all servers, no results are used by SpamAssassin.
Pyzor servers do not yet synchronize their servers, so it can be
beneficial to check and report to more than one. See the pyzor-users
mailing list for alternate servers that are not published via
'pyzor discover'.
If you are using multiple Pyzor servers, a good rule of thumb would be to
set the SpamAssassin plugin's timeout to be the same or just a bit more
than the per-server Pyzor timeout (e.g., 3.5 and 2 for two Pyzor servers).
If more than one of your Pyzor servers is always timing out, consider
removing one of them.
=cut
push (@cmds, {
setting => 'pyzor_timeout',
is_admin => 1,
default => 3.5,
type => $Mail::SpamAssassin::Conf::CONF_TYPE_DURATION
});
=item pyzor_options options
Specify additional options to the pyzor(1) command. Please note that only
characters in the range [0-9A-Za-z ,._/-] are allowed for security reasons.
=cut
push (@cmds, {
setting => 'pyzor_options',
is_admin => 1,
default => '',
type => $Mail::SpamAssassin::Conf::CONF_TYPE_STRING,
code => sub {
my ($self, $key, $value, $line) = @_;
if ($value !~ m{^([0-9A-Za-z ,._/-]+)$}) {
return $Mail::SpamAssassin::Conf::INVALID_VALUE;
}
$self->{pyzor_options} = $1;
}
});
=item pyzor_path STRING
This option tells SpamAssassin specifically where to find the C<pyzor>
client instead of relying on SpamAssassin to find it in the current
PATH. Note that if I<taint mode> is enabled in the Perl interpreter,
you should use this, as the current PATH will have been cleared.
=cut
push (@cmds, {
setting => 'pyzor_path',
is_admin => 1,
default => undef,
type => $Mail::SpamAssassin::Conf::CONF_TYPE_STRING,
code => sub {
my ($self, $key, $value, $line) = @_;
if (!defined $value || !length $value) {
return $Mail::SpamAssassin::Conf::MISSING_REQUIRED_VALUE;
}
$value = untaint_file_path($value);
if (!-x $value) {
info("config: pyzor_path \"$value\" isn't an executable");
return $Mail::SpamAssassin::Conf::INVALID_VALUE;
}
$self->{pyzor_path} = $value;
}
});
$conf->{parser}->register_commands(\@cmds);
}
sub is_pyzor_available {
my ($self) = @_;
my $pyzor = $self->{main}->{conf}->{pyzor_path} || '';
unless ($pyzor) {
$pyzor = Mail::SpamAssassin::Util::find_executable_in_env_path('pyzor');
}
unless ($pyzor && -x $pyzor) {
dbg("pyzor: pyzor is not available: no pyzor executable found");
return 0;
}
# remember any found pyzor
$self->{main}->{conf}->{pyzor_path} = $pyzor;
dbg("pyzor: pyzor is available: " . $self->{main}->{conf}->{pyzor_path});
return 1;
}
sub get_pyzor_interface {
my ($self) = @_;
if (!$self->{main}->{conf}->{use_pyzor}) {
dbg("pyzor: use_pyzor option not enabled, disabling Pyzor");
$self->{pyzor_interface} = "disabled";
$self->{pyzor_available} = 0;
}
elsif ($self->is_pyzor_available()) {
$self->{pyzor_interface} = "pyzor";
$self->{pyzor_available} = 1;
}
else {
dbg("pyzor: no pyzor found, disabling Pyzor");
$self->{pyzor_available} = 0;
}
}
sub check_pyzor {
my ($self, $permsgstatus, $full) = @_;
# initialize valid tags
$permsgstatus->{tag_data}->{PYZOR} = "";
my $timer = $self->{main}->time_method("check_pyzor");
$self->get_pyzor_interface();
return 0 unless $self->{pyzor_available};
return $self->pyzor_lookup($permsgstatus, $full);
}
sub pyzor_lookup {
my ($self, $permsgstatus, $fulltext) = @_;
my @response;
my $pyzor_count;
my $pyzor_whitelisted;
my $timeout = $self->{main}->{conf}->{pyzor_timeout};
$pyzor_count = 0;
$pyzor_whitelisted = 0;
my $pid;
# use a temp file here -- open2() is unreliable, buffering-wise, under spamd
my $tmpf = $permsgstatus->create_fulltext_tmpfile($fulltext);
# note: not really tainted, this came from system configuration file
my $path = untaint_file_path($self->{main}->{conf}->{pyzor_path});
my $opts = untaint_var($self->{main}->{conf}->{pyzor_options}) || '';
$permsgstatus->enter_helper_run_mode();
my $timer = Mail::SpamAssassin::Timeout->new(
{ secs => $timeout, deadline => $permsgstatus->{master_deadline} });
my $err = $timer->run_and_catch(sub {
local $SIG{PIPE} = sub { die "__brokenpipe__ignore__\n" };
dbg("pyzor: opening pipe: " . join(' ', $path, $opts, "check", "< $tmpf"));
$pid = Mail::SpamAssassin::Util::helper_app_pipe_open(*PYZOR,
$tmpf, 1, $path, split(' ', $opts), "check");
$pid or die "$!\n";
# read+split avoids a Perl I/O bug (Bug 5985)
my($inbuf,$nread,$resp); $resp = '';
while ( $nread=read(PYZOR,$inbuf,8192) ) { $resp .= $inbuf }
defined $nread or die "error reading from pipe: $!";
@response = split(/^/m, $resp, -1); undef $resp;
my $errno = 0; close PYZOR or $errno = $!;
if (proc_status_ok($?,$errno)) {
dbg("pyzor: [%s] finished successfully", $pid);
} elsif (proc_status_ok($?,$errno, 0,1)) { # sometimes it exits with 1
dbg("pyzor: [%s] finished: %s", $pid, exit_status_str($?,$errno));
} else {
info("pyzor: [%s] error: %s", $pid, exit_status_str($?,$errno));
}
if (!@response) {
# this exact string is needed below
die("no response\n"); # yes, this is possible
}
chomp for @response;
dbg("pyzor: got response: " . join("\\n", @response));
if ($response[0] =~ /^Traceback/) {
die("internal error, python traceback seen in response\n");
}
});
if (defined(fileno(*PYZOR))) { # still open
if ($pid) {
if (kill('TERM',$pid)) { dbg("pyzor: killed stale helper [$pid]") }
else { dbg("pyzor: killing helper application [$pid] failed: $!") }
}
my $errno = 0; close PYZOR or $errno = $!;
proc_status_ok($?,$errno)
or info("pyzor: [%s] error: %s", $pid, exit_status_str($?,$errno));
}
$permsgstatus->leave_helper_run_mode();
if ($timer->timed_out()) {
dbg("pyzor: check timed out after $timeout seconds");
return 0;
}
if ($err) {
chomp $err;
if ($err eq "__brokenpipe__ignore__") {
dbg("pyzor: check failed: broken pipe");
} elsif ($err eq "no response") {
dbg("pyzor: check failed: no response");
} else {
warn("pyzor: check failed: $err\n");
}
return 0;
}
foreach my $one_response (@response) {
# this regexp is intended to be a little bit forgiving
if ($one_response =~ /^\S+\t.*?\t(\d+)\t(\d+)\s*$/) {
# until pyzor servers can sync their DBs,
# sum counts obtained from all servers
$pyzor_whitelisted += $2+0;
$pyzor_count += $1+0;
}
else {
# warn on failures to parse
dbg("pyzor: failure to parse response \"$one_response\"");
}
}
$permsgstatus->set_tag('PYZOR', $pyzor_whitelisted ? "Whitelisted."
: "Reported $pyzor_count times.");
if ($pyzor_count >= $self->{main}->{conf}->{pyzor_max}) {
dbg("pyzor: listed: COUNT=$pyzor_count/$self->{main}->{conf}->{pyzor_max} WHITELIST=$pyzor_whitelisted");
return 1;
}
return 0;
}
sub plugin_report {
my ($self, $options) = @_;
return unless $self->{pyzor_available};
return unless $self->{main}->{conf}->{use_pyzor};
if (!$options->{report}->{options}->{dont_report_to_pyzor} && $self->is_pyzor_available())
{
# use temporary file: open2() is unreliable due to buffering under spamd
my $tmpf = $options->{report}->create_fulltext_tmpfile($options->{text});
if ($self->pyzor_report($options, $tmpf)) {
$options->{report}->{report_available} = 1;
info("reporter: spam reported to Pyzor");
$options->{report}->{report_return} = 1;
}
else {
info("reporter: could not report spam to Pyzor");
}
$options->{report}->delete_fulltext_tmpfile();
}
}
sub pyzor_report {
my ($self, $options, $tmpf) = @_;
# note: not really tainted, this came from system configuration file
my $path = untaint_file_path($options->{report}->{conf}->{pyzor_path});
my $opts = untaint_var($options->{report}->{conf}->{pyzor_options}) || '';
my $timeout = $self->{main}->{conf}->{pyzor_timeout};
$options->{report}->enter_helper_run_mode();
my $timer = Mail::SpamAssassin::Timeout->new({ secs => $timeout });
my $err = $timer->run_and_catch(sub {
local $SIG{PIPE} = sub { die "__brokenpipe__ignore__\n" };
dbg("pyzor: opening pipe: " . join(' ', $path, $opts, "report", "< $tmpf"));
my $pid = Mail::SpamAssassin::Util::helper_app_pipe_open(*PYZOR,
$tmpf, 1, $path, split(' ', $opts), "report");
$pid or die "$!\n";
my($inbuf,$nread,$nread_all); $nread_all = 0;
# response is ignored, just check its existence
while ( $nread=read(PYZOR,$inbuf,8192) ) { $nread_all += $nread }
defined $nread or die "error reading from pipe: $!";
dbg("pyzor: empty response") if $nread_all < 1;
my $errno = 0; close PYZOR or $errno = $!;
# closing a pipe also waits for the process executing on the pipe to
# complete, no need to explicitly call waitpid
# my $child_stat = waitpid($pid,0) > 0 ? $? : undef;
if (proc_status_ok($?,$errno, 0)) {
dbg("pyzor: [%s] reporter finished successfully", $pid);
} else {
info("pyzor: [%s] reporter error: %s", $pid, exit_status_str($?,$errno));
}
});
$options->{report}->leave_helper_run_mode();
if ($timer->timed_out()) {
dbg("reporter: pyzor report timed out after $timeout seconds");
return 0;
}
if ($err) {
chomp $err;
if ($err eq '__brokenpipe__ignore__') {
dbg("reporter: pyzor report failed: broken pipe");
} else {
warn("reporter: pyzor report failed: $err\n");
}
return 0;
}
return 1;
}
1;
=back
=cut
|