/usr/share/perl5/Mail/SpamAssassin/Plugin/Razor2.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 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 | # <@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::Razor2 - perform Razor check of messages
=head1 SYNOPSIS
loadplugin Mail::SpamAssassin::Plugin::Razor2
=head1 DESCRIPTION
Vipul's Razor is a distributed, collaborative, spam detection and
filtering network based on user submissions of spam. Detection is done
with signatures that efficiently spot mutating spam content and user
input is validated through reputation assignments.
See http://razor.sourceforge.net/ for more information about Razor.
=head1 USER SETTINGS
=over 4
=cut
package Mail::SpamAssassin::Plugin::Razor2;
use Mail::SpamAssassin::Plugin;
use Mail::SpamAssassin::Logger;
use Mail::SpamAssassin::Timeout;
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);
# figure out if razor is even available or not ...
$self->{razor2_available} = 0;
if ($mailsaobject->{local_tests_only}) {
dbg("razor2: local tests only, skipping Razor");
}
else {
if (eval { require Razor2::Client::Agent; }) {
$self->{razor2_available} = 1;
dbg("razor2: razor2 is available, version " . $Razor2::Client::Version::VERSION . "\n");
}
else {
dbg("razor2: razor2 is not available");
}
}
$self->register_eval_rule("check_razor2");
$self->register_eval_rule("check_razor2_range");
$self->set_config($mailsaobject->{conf});
return $self;
}
sub set_config {
my ($self, $conf) = @_;
my @cmds;
=item use_razor2 (0|1) (default: 1)
Whether to use Razor2, if it is available.
=cut
push(@cmds, {
setting => 'use_razor2',
default => 1,
type => $Mail::SpamAssassin::Conf::CONF_TYPE_NUMERIC,
});
=back
=head1 ADMINISTRATOR SETTINGS
=over 4
=item razor_timeout n (default: 5)
How many seconds you wait for Razor to complete before you go on without
the results
=cut
push(@cmds, {
setting => 'razor_timeout',
is_admin => 1,
default => 5,
type => $Mail::SpamAssassin::Conf::CONF_TYPE_DURATION,
});
=item razor_config filename
Define the filename used to store Razor's configuration settings.
Currently this is left to Razor to decide.
=cut
push(@cmds, {
setting => 'razor_config',
is_admin => 1,
type => $Mail::SpamAssassin::Conf::CONF_TYPE_STRING,
});
$conf->{parser}->register_commands(\@cmds);
}
sub razor2_access {
my ($self, $fulltext, $type, $deadline) = @_;
my $timeout = $self->{main}->{conf}->{razor_timeout};
my $return = 0;
my @results;
my $debug = $type eq 'check' ? 'razor2' : 'reporter';
# razor also debugs to stdout. argh. fix it to stderr...
if (would_log('dbg', $debug)) {
open(OLDOUT, ">&STDOUT");
open(STDOUT, ">&STDERR");
}
Mail::SpamAssassin::PerMsgStatus::enter_helper_run_mode($self);
my $rnd = rand(0x7fffffff); # save entropy before Razor clobbers it
my $timer = Mail::SpamAssassin::Timeout->new(
{ secs => $timeout, deadline => $deadline });
my $err = $timer->run_and_catch(sub {
local ($^W) = 0; # argh, warnings in Razor
# everything's in the module!
my $rc = Razor2::Client::Agent->new("razor-$type");
if ($rc) {
$rc->{opt} = {
debug => (would_log('dbg', $debug) > 1),
foreground => 1,
config => $self->{main}->{conf}->{razor_config}
};
# no facility prefix on this die
$rc->do_conf() or die "$debug: " . $rc->errstr;
# Razor2 requires authentication for reporting
my $ident;
if ($type ne 'check') {
# no facility prefix on this die
$ident = $rc->get_ident
or die("$type requires authentication");
}
my @msg = ($fulltext);
# no facility prefix on this die
my $objects = $rc->prepare_objects(\@msg)
or die "$debug: error in prepare_objects";
unless ($rc->get_server_info()) {
my $error = $rc->errprefix("$debug: spamassassin") || "$debug: razor2 had unknown error during get_server_info";
die $error;
}
# let's reset the alarm since get_server_info() calls
# nextserver() which calls discover() which very likely will
# reset the alarm for us ... how polite. :(
$timer->reset();
# no facility prefix on this die
my $sigs = $rc->compute_sigs($objects)
or die "$debug: error in compute_sigs";
# if mail isn't whitelisted, check it out
# see 'man razor-whitelist'
if ($type ne 'check' || ! $rc->local_check($objects->[0])) {
# provide a better error message when servers are unavailable,
# than "Bad file descriptor Died".
$rc->connect() or die "$debug: could not connect to any servers\n";
# Talk to the Razor server and do work
if ($type eq 'check') {
unless ($rc->check($objects)) {
my $error = $rc->errprefix("$debug: spamassassin") || "$debug: razor2 had unknown error during check";
die $error;
}
}
else {
unless ($rc->authenticate($ident)) {
my $error = $rc->errprefix("$debug: spamassassin") || "$debug: razor2 had unknown error during authenticate";
die $error;
}
unless ($rc->report($objects)) {
my $error = $rc->errprefix("$debug: spamassassin") || "$debug: razor2 had unknown error during report";
die $error;
}
}
unless ($rc->disconnect()) {
my $error = $rc->errprefix("$debug: spamassassin") || "$debug: razor2 had unknown error during disconnect";
die $error;
}
}
# Razor 2.14 says that if we get here, we did ok.
$return = 1;
# figure out if we have a log file we need to close...
if (ref($rc->{logref}) && exists $rc->{logref}->{fd}) {
# the fd can be stdout or stderr, so we need to find out if it is
# so we don't close them by accident. Note: we can't just
# undef the fd here (like the IO::Handle manpage says we can)
# because it won't actually close, unfortunately. :(
my $untie = 1;
foreach my $log (*STDOUT{IO}, *STDERR{IO}) {
if ($log == $rc->{logref}->{fd}) {
$untie = 0;
last;
}
}
if ($untie) {
close($rc->{logref}->{fd}) or die "error closing log: $!";
}
}
if ($type eq 'check') {
# so $objects->[0] is the first (only) message, and ->{spam} is a general yes/no
push(@results, { result => $objects->[0]->{spam} });
# great for debugging, but leave this off!
#use Data::Dumper;
#print Dumper($objects),"\n";
# ->{p} is for each part of the message
# so go through each part, taking the highest cf we find
# of any part that isn't contested (ct). This helps avoid false
# positives. equals logic_method 4.
#
# razor-agents < 2.14 have a different object format, so we now support both.
# $objects->[0]->{resp} vs $objects->[0]->{p}->[part #]->{resp}
my $part = 0;
my $arrayref = $objects->[0]->{p} || $objects;
if (defined $arrayref) {
foreach my $cf (@{$arrayref}) {
if (exists $cf->{resp}) {
for (my $response=0; $response<@{$cf->{resp}}; $response++) {
my $tmp = $cf->{resp}->[$response];
my $tmpcf = $tmp->{cf}; # Part confidence
my $tmpct = $tmp->{ct}; # Part contested?
my $engine = $cf->{sent}->[$response]->{e};
# These should always be set, but just in case ...
$tmpcf = 0 unless defined $tmpcf;
$tmpct = 0 unless defined $tmpct;
$engine = 0 unless defined $engine;
push(@results,
{ part => $part, engine => $engine, contested => $tmpct, confidence => $tmpcf });
}
}
else {
push(@results, { part => $part, noresponse => 1 });
}
$part++;
}
}
else {
# If we have some new $objects format that isn't close to
# the current razor-agents 2.x version, we won't FP but we
# should alert in debug.
dbg("$debug: it looks like the internal Razor object has changed format!");
}
}
}
else {
warn "$debug: undefined Razor2::Client::Agent\n";
}
});
# OK, that's enough Razor stuff. now, reset all that global
# state it futzes with :(
# work around serious brain damage in Razor2 (constant seed)
$rnd ^= int(rand(0xffffffff)); # mix old acc with whatever came out of razor
srand; # let Perl give it a try ...
$rnd ^= int(rand(0xffffffff)); # ... and mix-in that too
srand($rnd & 0x7fffffff); # reseed, keep it unsigned 32-bit just in case
Mail::SpamAssassin::PerMsgStatus::leave_helper_run_mode($self);
if ($timer->timed_out()) {
dbg("$debug: razor2 $type timed out after $timeout seconds");
}
if ($err) {
chomp $err;
if ($err =~ /(?:could not connect|network is unreachable)/) {
# make this a dbg(); SpamAssassin will still continue,
# but without Razor checking. otherwise there may be
# DSNs and errors in syslog etc., yuck
dbg("$debug: razor2 $type could not connect to any servers");
} elsif ($err =~ /timeout/i) {
dbg("$debug: razor2 $type timed out connecting to servers");
} else {
warn("$debug: razor2 $type failed: $! $err");
}
}
# razor also debugs to stdout. argh. fix it to stderr...
if (would_log('dbg', $debug)) {
open(STDOUT, ">&OLDOUT");
close OLDOUT;
}
return wantarray ? ($return, @results) : $return;
}
sub plugin_report {
my ($self, $options) = @_;
return unless $self->{razor2_available};
return if $self->{main}->{local_tests_only};
return unless $self->{main}->{conf}->{use_razor2};
return if $options->{report}->{options}->{dont_report_to_razor};
if ($self->razor2_access($options->{text}, 'report', undef)) {
$options->{report}->{report_available} = 1;
info('reporter: spam reported to Razor');
$options->{report}->{report_return} = 1;
}
else {
info('reporter: could not report spam to Razor');
}
}
sub plugin_revoke {
my ($self, $options) = @_;
return unless $self->{razor2_available};
return if $self->{main}->{local_tests_only};
return unless $self->{main}->{conf}->{use_razor2};
return if $options->{revoke}->{options}->{dont_report_to_razor};
if ($self->razor2_access($options->{text}, 'revoke', undef)) {
$options->{revoke}->{revoke_available} = 1;
dbg('reporter: spam revoked from Razor');
$options->{revoke}->{revoke_return} = 1;
}
else {
dbg('reporter: could not revoke spam from Razor');
}
}
sub check_razor2 {
my ($self, $permsgstatus, $full) = @_;
return $permsgstatus->{razor2_result} if (defined $permsgstatus->{razor2_result});
$permsgstatus->{razor2_result} = 0;
$permsgstatus->{razor2_cf_score} = { '4' => 0, '8' => 0 };
return unless $self->{razor2_available};
return unless $self->{main}->{conf}->{use_razor2};
my $timer = $self->{main}->time_method("check_razor2");
my $return;
my @results;
# TODO: check for cache header, set results appropriately
# do it this way to make it easier to get out the results later from the
# netcache plugin
($return, @results) =
$self->razor2_access($full, 'check', $permsgstatus->{master_deadline});
$self->{main}->call_plugins ('process_razor_result',
{ results => \@results, permsgstatus => $permsgstatus }
);
foreach my $result (@results) {
if (exists $result->{result}) {
$permsgstatus->{razor2_result} = $result->{result} if $result->{result};
}
elsif ($result->{noresponse}) {
dbg('razor2: part=' . $result->{part} . ' noresponse');
}
else {
dbg('razor2: part=' . $result->{part} .
' engine=' . $result->{engine} .
' contested=' . $result->{contested} .
' confidence=' . $result->{confidence});
next if $result->{contested};
my $cf = $permsgstatus->{razor2_cf_score}->{$result->{engine}} || 0;
if ($result->{confidence} > $cf) {
$permsgstatus->{razor2_cf_score}->{$result->{engine}} = $result->{confidence};
}
}
}
dbg("razor2: results: spam? " . $permsgstatus->{razor2_result});
while(my ($engine, $cf) = each %{$permsgstatus->{razor2_cf_score}}) {
dbg("razor2: results: engine $engine, highest cf score: $cf");
}
return $permsgstatus->{razor2_result};
}
# Check the cf value of a given message and return if it's within the
# given range
sub check_razor2_range {
my ($self, $permsgstatus, $body, $engine, $min, $max) = @_;
# If Razor2 isn't available, or the general test is disabled, don't
# continue.
return unless $self->{razor2_available};
return unless $self->{main}->{conf}->{use_razor2};
return unless $self->{main}->{conf}->{scores}->{'RAZOR2_CHECK'};
# If Razor2 hasn't been checked yet, go ahead and run it.
unless (defined $permsgstatus->{razor2_result}) {
$self->check_razor2($permsgstatus, $body);
}
my $cf = 0;
if ($engine) {
$cf = $permsgstatus->{razor2_cf_score}->{$engine};
return unless defined $cf;
}
else {
# If no specific engine was given to the rule, find the highest cf
# determined and use that
while(my ($engine, $ecf) = each %{$permsgstatus->{razor2_cf_score}}) {
if ($ecf > $cf) {
$cf = $ecf;
}
}
}
if ($cf >= $min && $cf <= $max) {
$permsgstatus->test_log(sprintf("cf: %3d", $cf));
return 1;
}
return;
}
1;
=back
=cut
|