You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@spamassassin.apache.org by jq...@apache.org on 2015/06/05 17:35:29 UTC
svn commit: r1683783 -
/spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/TxRep.pm
Author: jquinn
Date: Fri Jun 5 15:35:29 2015
New Revision: 1683783
URL: http://svn.apache.org/r1683783
Log:
Improved documentation of DKIM verification and other functions
Modified:
spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/TxRep.pm
Modified: spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/TxRep.pm
URL: http://svn.apache.org/viewvc/spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/TxRep.pm?rev=1683783&r1=1683782&r2=1683783&view=diff
==============================================================================
--- spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/TxRep.pm (original)
+++ spamassassin/trunk/lib/Mail/SpamAssassin/Plugin/TxRep.pm Fri Jun 5 15:35:29 2015
@@ -648,11 +648,16 @@ Used by the SQLBasedAddrList storage imp
If this option is set the SQLBasedAddrList module will keep separate
database entries for DKIM-validated e-mail addresses and for non-validated
-ones. A pre-requisite when setting this option is that a field awl.signedby
-exists in a SQL table, otherwise SQL operations will fail (which is why we
-need this option at all - for compatibility with pre-3.3.0 database schema).
-A plugin DKIM should also be enabled, as otherwise there is no benefit from
-turning on this option.
+ones. Without this option, or for domains that do not use a DKIM signature,
+the reputation of legitimate email can get mixed with the reputation of
+forgeries. A pre-requisite when setting this option is that a field
+txrep.signedby exists in a SQL table, otherwise SQL operations will fail.
+A DKIM plugin must also be enabled in order for this option to take effect.
+This option is highly recommended. Unless you are using a pre-3.3.0 database
+schema and cannot upgrade, there is no reason to disable this option. If
+you are upgrading from AWL and using a pre-3.3.0 schema, the txrep.signedby
+column will not exist. It is recommended that you add this column, but if
+that is not possible you must set this option to 0 to avoid SQL errors.
=cut # ...................................................................
push (@cmds, {
@@ -1218,6 +1223,7 @@ sub check_senders_reputation {
my $autolearn = defined $self->{autolearn};
$self->{last_pms} = $self->{autolearn} = undef;
+ # Cases where we would not be able to use TxRep
return 0 unless ($self->{conf}->{use_txrep});
if ($self->{conf}->{use_auto_whitelist}) {
warn("TxRep: cannot run when Auto-Whitelist is enabled. Please disable it!\n");
@@ -1246,6 +1252,7 @@ sub check_senders_reputation {
my $domain = $from;
$domain =~ s/^.+@//;
+ # Find the last untrusted relay and populate helo and original IP
my ($origip, $helo);
if (defined $pms->{relays_trusted} || defined $pms->{relays_untrusted}) {
my $trusteds = @{$pms->{relays_trusted}};
@@ -1264,6 +1271,7 @@ sub check_senders_reputation {
}
}
+ # Look for previous scores of the same message, for instance when doing re-learning
if ($self->{conf}->{txrep_track_messages}) {
if ($msg_id) {
my $msg_rep = $self->check_reputations($pms, 'MSG_ID', $msg_id, undef, $date, undef);
@@ -1304,7 +1312,10 @@ sub check_senders_reputation {
}
}
+ # Get the signing domain
my $signedby = ($self->{conf}->{auto_whitelist_distinguish_signed})? $pms->get_tag('DKIMDOMAIN') : undef;
+
+ # Summary of all information we've gathered so far
dbg("TxRep: active, %s pre-score: %s, autolearn score: %s, IP: %s, address: %s %s",
$msg_id || '',
$pms->{score} || '?',
@@ -1326,6 +1337,7 @@ sub check_senders_reputation {
my $totalweight = 0;
$self->{totalweight} = $totalweight;
+ # Get current reputation info
$delta += $self->check_reputations($pms, 'EMAIL_IP', $from, $ip, $signedby, $msgscore);
if ($domain) {
@@ -1341,6 +1353,7 @@ sub check_senders_reputation {
$delta += $self->check_reputations($pms, 'IP', $origip, undef, undef, $msgscore);
}
+ # Learn against this message and store reputation
if (!defined $self->{learning}) {
$delta = ($self->{totalweight})? $self->{conf}->{txrep_factor} * $delta / $self->{totalweight} : 0;
if ($delta) {
@@ -1351,9 +1364,11 @@ sub check_senders_reputation {
dbg("TxRep: post-TxRep score: %.3f", $pms->{score});
}
}
+ # Track message ID
if ($self->{conf}->{txrep_track_messages} && $msg_id) {
$self->check_reputations($pms, 'MSG_ID', $msg_id, undef, $date, $msgscore);
}
+ # Close any open resources
if (!defined $self->{txKeepStoreTied}) {
$self->finish();
}