=head1 NAME Mail::SpamAssassin::Conf - SpamAssassin configuration file =head1 SYNOPSIS # a comment rewrite_subject 1 full PARA_A_2_C_OF_1618 /Paragraph .a.{0,10}2.{0,10}C. of S. 1618/i describe PARA_A_2_C_OF_1618 Claims compliance with senate bill 1618 header FROM_HAS_MIXED_NUMS From =~ /\d+[a-z]+\d+\S*@/i describe FROM_HAS_MIXED_NUMS From: contains numbers mixed in with letters score A_HREF_TO_REMOVE 2.0 lang es describe FROM_FORGED_HOTMAIL Forzado From: simula ser de hotmail.com =head1 DESCRIPTION SpamAssassin is configured using some traditional UNIX-style configuration files, loaded from the /usr/share/spamassassin and /etc/mail/spamassassin directories. The C<#> character starts a comment, which continues until end of line. Whitespace in the files is not significant, but please note that starting a line with whitespace is deprecated, as we reserve its use for multi-line rule definitions, at some point in the future. Currently, each rule or configuration setting must fit on one-line; multi-line settings are not supported yet. Paths can use C<~> to refer to the user's home directory. Where appropriate, default values are listed in parentheses. =head1 TAGS The following C can be used as placeholders in certain options specified below. They will be replaced by the corresponding value when they are used. Some tags can take an argument (in parentheses). The argument is optional, and the default is shown below. _YESNOCAPS_ "YES"/"NO" for is/isn't spam _YESNO_ "Yes"/"No" for is/isn't spam _HITS_ message score _REQD_ message threshold _VERSION_ version (eg. 2.55) _SUBVERSION_ sub-version (eg. 1.187-2003-05-15-exp) _HOSTNAME_ hostname _BAYES_ bayes score _AWL_ AWL modifier _DATE_ rfc-2822 date of scan _STARS(*)_ one * (use any character) for each score point (note: this is limited to 50 'stars' to stay on the right side of the RFCs) _RELAYSTRUSTED_ relays used and deemed to be trusted _RELAYSUNTRUSTED_ relays used that can not be trusted _AUTOLEARN_ autolearn status ("ham", "no", "spam") _TESTS(,)_ tests hit separated by , (or other separator) _TESTSSCORES(,)_ as above, except with scores appended (eg. AWL=-3.0,...) _DCCB_ DCC's "Brand" _DCCR_ DCC's results _PYZOR_ Pyzor results _RBL_ full results for positive RBL queries in DNS URI format _LANGUAGES_ possible languages of mail _PREVIEW_ content preview _REPORT_ terse report of tests hits (for header reports) _SUMMARY_ summary of tests hit for standard report (for body reports) _CONTACTADDRESS_ contents of the 'report_contact' setting =head1 USER PREFERENCES The following options can be used in both site-wide (C) and user-specific (C) configuration files to customize how SpamAssassin handles incoming email messages. =cut package Mail::SpamAssassin::Conf; use Mail::SpamAssassin::Util; use Mail::SpamAssassin::NetSet; use strict; use bytes; use vars qw{ @ISA $VERSION }; @ISA = qw(); # odd => eval test use constant TYPE_HEAD_TESTS => 0x0008; use constant TYPE_HEAD_EVALS => 0x0009; use constant TYPE_BODY_TESTS => 0x000a; use constant TYPE_BODY_EVALS => 0x000b; use constant TYPE_FULL_TESTS => 0x000c; use constant TYPE_FULL_EVALS => 0x000d; use constant TYPE_RAWBODY_TESTS => 0x000e; use constant TYPE_RAWBODY_EVALS => 0x000f; use constant TYPE_URI_TESTS => 0x0010; use constant TYPE_URI_EVALS => 0x0011; use constant TYPE_META_TESTS => 0x0012; use constant TYPE_RBL_EVALS => 0x0013; $VERSION = 'bogus'; # avoid CPAN.pm picking up version strings later ########################################################################### sub new { my $class = shift; $class = ref($class) || $class; my $self = { }; bless ($self, $class); $self->{errors} = 0; $self->{tests} = { }; $self->{descriptions} = { }; $self->{test_types} = { }; $self->{scoreset} = [ {}, {}, {}, {} ]; $self->{scoreset_current} = 0; $self->set_score_set (0); $self->{tflags} = { }; $self->{source_file} = { }; # after parsing, tests are refiled into these hashes for each test type. # this allows e.g. a full-text test to be rewritten as a body test in # the user's ~/.spamassassin.cf file. $self->{body_tests} = { }; $self->{uri_tests} = { }; $self->{uri_evals} = { }; # not used/implemented yet $self->{head_tests} = { }; $self->{head_evals} = { }; $self->{body_evals} = { }; $self->{full_tests} = { }; $self->{full_evals} = { }; $self->{rawbody_tests} = { }; $self->{rawbody_evals} = { }; $self->{meta_tests} = { }; # testing stuff $self->{regression_tests} = { }; $self->{required_hits} = 5.0; $self->{report_charset} = ''; $self->{report_template} = ''; $self->{unsafe_report_template} = ''; $self->{spamtrap_template} = ''; $self->{num_check_received} = 9; $self->{use_razor2} = 1; $self->{razor_config} = undef; $self->{razor_timeout} = 10; $self->{rbl_timeout} = 15; # this will be sedded by implementation code, so ~ is OK. # using "__userstate__" is recommended for defaults, as it allows # Mail::SpamAssassin module users who set that configuration setting, # to receive the correct values. $self->{auto_whitelist_path} = "__userstate__/auto-whitelist"; $self->{auto_whitelist_file_mode} = '0700'; $self->{auto_whitelist_factor} = 0.5; $self->{rewrite_subject} = 0; $self->{subject_tag} = '*****SPAM*****'; $self->{report_safe} = 1; $self->{report_contact} = 'the administrator of that system'; $self->{skip_rbl_checks} = 0; $self->{dns_available} = "test"; $self->{check_mx_attempts} = 2; $self->{check_mx_delay} = 5; $self->{ok_locales} = 'all'; $self->{ok_languages} = 'all'; $self->{allow_user_rules} = 0; $self->{user_rules_to_compile} = { }; $self->{fold_headers} = 1; $self->{headers_spam} = { }; $self->{headers_ham} = { }; $self->{use_dcc} = 1; $self->{dcc_path} = undef; # Browse PATH $self->{dcc_body_max} = 999999; $self->{dcc_fuz1_max} = 999999; $self->{dcc_fuz2_max} = 999999; $self->{dcc_timeout} = 10; $self->{dcc_options} = '-R'; $self->{use_pyzor} = 1; $self->{pyzor_path} = undef; # Browse PATH $self->{pyzor_max} = 5; $self->{pyzor_timeout} = 10; $self->{pyzor_options} = ''; $self->{use_bayes} = 1; $self->{bayes_auto_learn} = 1; $self->{bayes_auto_learn_threshold_nonspam} = 0.1; $self->{bayes_auto_learn_threshold_spam} = 12.0; $self->{bayes_learn_to_journal} = 0; $self->{bayes_path} = "__userstate__/bayes"; $self->{bayes_file_mode} = "0700"; $self->{bayes_use_hapaxes} = 1; $self->{bayes_use_chi2_combining} = 1; $self->{bayes_expiry_max_db_size} = 150000; $self->{bayes_auto_expire} = 1; $self->{bayes_journal_max_size} = 102400; $self->{bayes_ignore_headers} = [ ]; $self->{bayes_min_ham_num} = 200; $self->{bayes_min_spam_num} = 200; $self->{bayes_learn_during_report} = 1; $self->{whitelist_from} = { }; $self->{blacklist_from} = { }; $self->{blacklist_to} = { }; $self->{whitelist_to} = { }; $self->{more_spam_to} = { }; $self->{all_spam_to} = { }; $self->{trusted_networks} = Mail::SpamAssassin::NetSet->new(); # this will hold the database connection params $self->{user_scores_dsn} = ''; $self->{user_scores_sql_username} = ''; $self->{user_scores_sql_password} = ''; $self->{user_scores_sql_table} = 'userpref'; # Morgan - default to userpref for backwords compatibility # Michael 'Moose' Dinn, # For integration with Horde's preference storage # 20020831 $self->{user_scores_sql_field_username} = 'username'; $self->{user_scores_sql_field_preference} = 'preference'; $self->{user_scores_sql_field_value} = 'value'; $self->{user_scores_sql_field_scope} = 'spamassassin'; # probably shouldn't change this # for backwards compatibility, we need to set the default headers # remove this except for X-Spam-Checker-Version in 2.70 $self->add_default_spam_headers(); # always run this first $self->add_default_ham_headers(); # always run this second $self; } sub mtime { my $self = shift; if (@_) { $self->{mtime} = shift; } return $self->{mtime}; } sub add_default_spam_headers { my ($self) = @_; $self->{headers_spam}->{"Flag"} = "_YESNOCAPS_"; $self->{headers_spam}->{"Status"} = "_YESNO_, hits=_HITS_ required=_REQD_ tests=_TESTS_ autolearn=_AUTOLEARN_ version=_VERSION_"; $self->{headers_spam}->{"Level"} = "_STARS(*)_"; $self->{headers_spam}->{"Checker-Version"} = "SpamAssassin _VERSION_ (_SUBVERSION_) on _HOSTNAME_"; } sub add_default_ham_headers { my ($self) = @_; $self->{headers_ham}->{"Status"} = $self->{headers_spam}->{"Status"}; $self->{headers_ham}->{"Level"} = $self->{headers_spam}->{"Level"}; $self->{headers_ham}->{"Checker-Version"} = $self->{headers_spam}->{"Checker-Version"}; } ########################################################################### sub parse_scores_only { my ($self) = @_; $self->_parse ($_[1], 1); # don't copy $rules! } sub parse_rules { my ($self) = @_; $self->_parse ($_[1], 0); # don't copy $rules! } sub set_score_set { my ($self, $set) = @_; $self->{scores} = $self->{scoreset}->[$set]; $self->{scoreset_current} = $set; dbg("Score set $set chosen."); } sub get_score_set { my($self) = @_; return $self->{scoreset_current}; } sub _parse { my ($self, undef, $scoresonly) = @_; # leave $rules in $_[1] local ($_); $self->{scoresonly} = $scoresonly; # Language selection: # See http://www.gnu.org/manual/glibc-2.2.5/html_node/Locale-Categories.html # and http://www.gnu.org/manual/glibc-2.2.5/html_node/Using-gettextized-software.html my $lang = $ENV{'LANGUAGE'}; # LANGUAGE has the highest precedence but has a if ($lang) { # special format: The user may specify more than $lang =~ s/:.*$//; # one language here, colon separated. We use the } # first one only (lazy bums we are :o) $lang ||= $ENV{'LC_ALL'}; $lang ||= $ENV{'LC_MESSAGES'}; $lang ||= $ENV{'LANG'}; $lang ||= 'C'; # Nothing set means C/POSIX if ($lang =~ /^(C|POSIX)$/) { $lang = 'en_US'; # Our default language } else { $lang =~ s/[@.+,].*$//; # Strip codeset, modifier/audience, etc. } # (eg. .utf8 or @euro) $self->{currentfile} = '(no file)'; my $skipfile = 0; foreach (split (/\n/, $_[1])) { s/(?{currentfile} = $1; next; } if (/^file\s+end/) { $self->{currentfile} = '(no file)'; $skipfile = 0; next; } # convert all dashes in setting name to underscores. # Simplifies regexps below... 1 while s/^(\S+)\-(\S+)/$1_$2/g; =head2 VERSION OPTIONS =over 4 =item require_version n.nn Indicates that the entire file, from this line on, requires a certain version of SpamAssassin to run. If an older or newer version of SpamAssassin tries to read configuration from this file, it will output a warning instead, and ignore it. =cut if (/^require_version\s+(.*)$/) { my $req_version = $1; $req_version =~ s/^\@\@VERSION\@\@$/$Mail::SpamAssassin::VERSION/; if ($Mail::SpamAssassin::VERSION != $req_version) { warn "configuration file \"$self->{currentfile}\" requires version ". "$req_version of SpamAssassin, but this is code version ". "$Mail::SpamAssassin::VERSION. Maybe you need to use ". "the -C switch, or remove the old config files? ". "Skipping this file"; $skipfile = 1; $self->{errors}++; } next; } if ($skipfile) { next; } # note: no eval'd code should be loaded before the SECURITY line below. ########################################################################### =item version_tag string This tag is appended to the SA version in the X-Spam-Status header. You should include it when modify your ruleset, especially if you plan to distribute it. A good choice for I is your last name or your initials followed by a number which you increase with each change. e.g. version_tag myrules1 # version=2.41-myrules1 =cut if(/^version_tag\s+(.*)$/) { my $tag = lc($1); $tag =~ tr/a-z0-9./_/c; foreach (@Mail::SpamAssassin::EXTRA_VERSION) { if($_ eq $tag) { $tag = undef; last; } } push(@Mail::SpamAssassin::EXTRA_VERSION, $tag) if($tag); next; } =back =head2 WHITELIST AND BLACKLIST OPTIONS =over 4 =item whitelist_from add@ress.com Used to specify addresses which send mail that is often tagged (incorrectly) as spam; it also helps if they are addresses of big companies with lots of lawyers. This way, if spammers impersonate them, they'll get into big trouble, so it doesn't provide a shortcut around SpamAssassin. Whitelist and blacklist addresses are now file-glob-style patterns, so C, C<*@isp.com>, or C<*.domain.net> will all work. Specifically, C<*> and C are allowed, but all other metacharacters are not. Regular expressions are not used for security reasons. Multiple addresses per line, separated by spaces, is OK. Multiple C lines is also OK. The headers checked for whitelist addresses are as follows: if C is set, use that; otherwise check all addresses taken from the following set of headers: Envelope-Sender Resent-Sender X-Envelope-From From e.g. whitelist_from joe@example.com fred@example.com whitelist_from *@example.com =cut if (/^whitelist_from\s+(.+)$/) { $self->add_to_addrlist ('whitelist_from', split (' ', $1)); next; } =item unwhitelist_from add@ress.com Used to override a default whitelist_from entry, so for example a distribution whitelist_from can be overridden in a local.cf file, or an individual user can override a whitelist_from entry in their own C file. The specified email address has to match exactly the address previously used in a whitelist_from line. e.g. unwhitelist_from joe@example.com fred@example.com unwhitelist_from *@example.com =cut if (/^unwhitelist_from\s+(.+)$/) { $self->remove_from_addrlist ('whitelist_from', split (' ', $1)); next; } =item whitelist_from_rcvd addr@lists.sourceforge.net sourceforge.net Use this to supplement the whitelist_from addresses with a check against the Received headers. The first parameter is the address to whitelist, and the second is a string to match the relay's rDNS. This string is matched against the reverse DNS lookup used during the handover from the untrusted internet to your trusted network's mail exchangers. It can either be the full hostname, or the domain component of that hostname. In other words, if the host that connected to your MX had an IP address that mapped to 'sendinghost.spamassassin.org', you should specify C or just C here. Note that this requires that C be correct. For simple cases, it will be, but for a complex network, or if you're running with DNS checks off or with C<-L>, you may get better results by setting that parameter. e.g. whitelist_from_rcvd joe@example.com example.com whitelist_from_rcvd *@axkit.org sergeant.org =item def_whitelist_from_rcvd addr@lists.sourceforge.net sourceforge.net Same as C, but used for the default whitelist entries in the SpamAssassin distribution. The whitelist score is lower, because these are often targets for spammer spoofing. =cut if (/^whitelist_from_rcvd\s+(\S+)\s+(\S+)$/) { $self->add_to_addrlist_rcvd ('whitelist_from_rcvd', $1, $2); next; } if (/^def_whitelist_from_rcvd\s+(\S+)\s+(\S+)$/) { $self->add_to_addrlist_rcvd ('def_whitelist_from_rcvd', $1, $2); next; } =item unwhitelist_from_rcvd add@ress.com Used to override a default whitelist_from_rcvd entry, so for example a distribution whitelist_from_rcvd can be overridden in a local.cf file, or an individual user can override a whitelist_from_rcvd entry in their own C file. The specified email address has to match exactly the address previously used in a whitelist_from_rcvd line. e.g. unwhitelist_from_rcvd joe@example.com fred@example.com unwhitelist_from_rcvd *@axkit.org =cut if (/^unwhitelist_from_rcvd\s+(.+)$/) { $self->remove_from_addrlist_rcvd('whitelist_from_rcvd', split (' ', $1)); $self->remove_from_addrlist_rcvd('def_whitelist_from_rcvd', split (' ', $1)); next; } =item blacklist_from add@ress.com Used to specify addresses which send mail that is often tagged (incorrectly) as non-spam, but which the user doesn't want. Same format as C. =cut if (/^blacklist_from\s+(.+)$/) { $self->add_to_addrlist ('blacklist_from', split (' ', $1)); next; } =item unblacklist_from add@ress.com Used to override a default blacklist_from entry, so for example a distribution blacklist_from can be overridden in a local.cf file, or an individual user can override a blacklist_from entry in their own C file. e.g. unblacklist_from joe@example.com fred@example.com unblacklist_from *@spammer.com =cut if (/^unblacklist_from\s+(.+)$/) { $self->remove_from_addrlist ('blacklist_from', split (' ', $1)); next; } =item whitelist_to add@ress.com If the given address appears as a recipient in the message headers (Resent-To, To, Cc, obvious envelope recipient, etc.) the mail will be whitelisted. Useful if you're deploying SpamAssassin system-wide, and don't want some users to have their mail filtered. Same format as C. There are three levels of To-whitelisting, C, C and C. Users in the first level may still get some spammish mails blocked, but users in C should never get mail blocked. =item more_spam_to add@ress.com See above. =item all_spam_to add@ress.com See above. =cut if (/^whitelist_to\s+(.+)$/) { $self->add_to_addrlist ('whitelist_to', split (' ', $1)); next; } if (/^more_spam_to\s+(.+)$/) { $self->add_to_addrlist ('more_spam_to', split (' ', $1)); next; } if (/^all_spam_to\s+(.+)$/) { $self->add_to_addrlist ('all_spam_to', split (' ', $1)); next; } =item blacklist_to add@ress.com If the given address appears as a recipient in the message headers (Resent-To, To, Cc, obvious envelope recipient, etc.) the mail will be blacklisted. Same format as C. =cut if (/^blacklist_to\s+(.+)$/) { $self->add_to_addrlist ('blacklist_to', split (' ', $1)); next; } =back =head2 SCORING OPTIONS =over 4 =item required_hits n.nn (default: 5) Set the number of hits required before a mail is considered spam. C can be an integer or a real number. 5.0 is the default setting, and is quite aggressive; it would be suitable for a single-user setup, but if you're an ISP installing SpamAssassin, you should probably set the default to be more conservative, like 8.0 or 10.0. It is not recommended to automatically delete or discard messages marked as spam, as your users B complain, but if you choose to do so, only delete messages with an exceptionally high score such as 15.0 or higher. =cut if (/^required_hits\s+(\S+)$/) { $self->{required_hits} = $1+0.0; next; } =item score SYMBOLIC_TEST_NAME n.nn [ n.nn n.nn n.nn ] Assign scores (the number of points for a hit) to a given test. Scores can be positive or negative real numbers or integers. C is the symbolic name used by SpamAssassin for that test; for example, 'FROM_ENDS_IN_NUMS'. If only one valid score is listed, then that score is always used for a test. If four valid scores are listed, then the score that is used depends on how SpamAssassin is being used. The first score is used when both Bayes and network tests are disabled. The second score is used when Bayes is disabled, but network tests are enabled. The third score is used when Bayes is enabled and network tests are disabled. The fourth score is used when Bayes is enabled and network tests are enabled. Setting a rule's score to 0 will disable that rule from running. Note that test names which begin with '__' are reserved for meta-match sub-rules, and are not scored or listed in the 'tests hit' reports. If no score is given for a test, the default score is 1.0, or 0.01 for tests whose names begin with 'T_' (this is used to indicate a rule in testing). By convention, rule names are be all uppercase and have a length of no more than 22 characters. =cut if (my ($rule, $scores) = /^score\s+(\S+)\s+(.*)$/) { my @scores = ($scores =~ /(\-*[\d\.]+)(?:\s+|$)/g); if (scalar @scores == 4) { for my $index (0..3) { $self->{scoreset}->[$index]->{$rule} = $scores[$index] + 0.0; } } elsif (scalar @scores > 0) { for my $index (0..3) { $self->{scoreset}->[$index]->{$rule} = $scores[0] + 0.0; } } next; } =back =head2 MESSAGE TAGGING OPTIONS =over 4 =item rewrite_subject { 0 | 1 } (default: 0) By default, the subject lines of suspected spam will not be tagged. This can be enabled here. =cut if (/^rewrite_subject\s+(\d+)$/) { $self->{rewrite_subject} = $1+0; next; } =item fold_headers { 0 | 1 } (default: 1) By default, headers added by SpamAssassin will be whitespace folded. In other words, they will be broken up into multiple lines instead of one very long one and each other line will have a tabulator prepended to mark it as a continuation of the preceding one. The automatic wrapping can be disabled here (which can generate very long lines). =cut if (/^fold_headers\s+(\d+)$/) { $self->{fold_headers} = $1+0; next; } =item add_header { spam | ham | all } header_name string Customized headers can be added to the specified type of messages (spam, ham, or "all" to add to either). All headers begin with C (so a C Foo will generate a header called X-Spam-Foo). header_name is restricted to the character set [A-Za-z0-9_-]. C can contain tags as explained above in the TAGS section. You can also use C<\n> and C<\t> in the header to add newlines and tabulators as desired. A backslash has to be written as \\, any other escaped chars will be silently removed. All headers will be folded if fold_headers is set to C<1>. Note: Manually adding newlines via C<\n> disables any further automatic wrapping (ie: long header lines are possible). The lines will still be properly folded (marked as continuing) though. For backwards compatibility, some headers are (still) added by default. You can customize existing headers with add_header (only the specified subset of messages will be changed). See also C for removing headers. Here are some examples (these are the defaults in 2.60): add_header spam Flag _YESNOCAPS_ add_header all Status _YESNO_, hits=_HITS_ required=_REQD_ tests=_TESTS_ autolearn=_AUTOLEARN_ version=_VERSION_ add_header all Level _STARS(*)_ add_header all Checker-Version SpamAssassin _VERSION_ (_SUBVERSION_) on _HOSTNAME_ =cut if (/^add_header\s+(ham|spam|all)\s+([A-Za-z0-9_-]+)\s+(.*?)\s*$/) { my ($type, $name, $line) = ($1, $2, $3); if ($line =~ /^"(.*)"$/) { $line = $1; } my @line = split( /\\\\/, # split at backslashes, "$line\n" # newline needed to make trailing backslashes work ); map { s/\\t/\t/g; # expand tabs s/\\n/\n/g; # expand newlines s/\\.//g; # purge all other escapes } @line; $line = join("\\", @line); chop($line); # remove dummy newline again if (($type eq "ham") || ($type eq "all")) { $self->{headers_ham}->{$name} = $line; } if (($type eq "spam") || ($type eq "all")) { $self->{headers_spam}->{$name} = $line; } next; } =item remove_header { spam | ham | all } header_name Headers can be removed from the specified type of messages (spam, ham, or "all" to remove from either). All headers begin with C (so C will be appended to C). See also C for removing all the headers at once. Note that B is not removable because the version information is needed by mail administrators and developers to debug problems. Without at least one header, it might not even be possible to determine that SpamAssassin is running. =cut if (/^remove_header\s+(ham|spam|all)\s+([A-Za-z0-9_-]+)\s*$/) { my ($type, $name) = ($1, $2); next if ( $name eq "Checker-Version" ); if (($type eq "ham") || ($type eq "all")) { delete $self->{headers_ham}->{$name}; } if (($type eq "spam") || ($type eq "all")) { delete $self->{headers_spam}->{$name}; } next; } =item clear_headers Clear the list of headers to be added to messages. You may use this before any add_header options to prevent the default headers from being added to the message. Note that B is not removable because the version information is needed by mail administrators and developers to debug problems. Without at least one header, it might not even be possible to determine that SpamAssassin is running. =cut if (/^clear_headers\s*$/) { for my $name (keys %{ $self->{headers_ham} }) { delete $self->{headers_ham}->{$name} if $name ne "Checker-Version"; } for my $name (keys %{ $self->{headers_spam} }) { delete $self->{headers_spam}->{$name} if $name ne "Checker-Version"; } next; } =item report_safe_copy_headers header_name ... If using report_safe, a few of the headers from the original message are copied into the wrapper header (From, To, Cc, Subject, Date, etc.) If you want to have other headers copied as well, you can add them using this option. You can specify multiple headers on the same line, separated by spaces, or you can just use multiple lines. =cut if (/^report_safe_copy_headers\s+(.+?)\s*$/) { push(@{$self->{report_safe_copy_headers}}, split(/\s+/, $1)); next; } =item subject_tag STRING ... (default: *****SPAM*****) Text added to the C line of mails that are considered spam, if C is 1. Tags can be used here as with the add_header option. If report_safe is not used (see below), you may only use the _HITS_ and _REQD_ tags, or SpamAssassin will not be able to remove this markup from your message. =cut if (/^subject_tag\s+(.+)$/) { $self->{subject_tag} = $1; next; } =item report_safe { 0 | 1 | 2 } (default: 1) if this option is set to 1, if an incoming message is tagged as spam, instead of modifying the original message, SpamAssassin will create a new report message and attach the original message as a message/rfc822 MIME part (ensuring the original message is completely preserved, not easily opened, and easier to recover). If this option is set to 2, then original messages will be attached with a content type of text/plain instead of message/rfc822. This setting may be required for safety reasons on certain broken mail clients that automatically load attachments without any action by the user. This setting may also make it somewhat more difficult to extract or view the original message. If this option is set to 0, incoming spam is only modified by adding some C headers and no changes will be made to the body. In addition, a header named B will be added to spam. You can use the B option to remove that header after setting B to 0. =cut if (/^report_safe\s+(\d+)$/) { $self->{report_safe} = $1+0; if (! $self->{report_safe}) { $self->{headers_spam}->{"Report"} = "_REPORT_"; } next; } =item report_charset CHARSET (default: unset) Set the MIME Content-Type charset used for the text/plain report which is attached to spam mail messages. =cut if (/^report_charset\s*(.*)$/) { $self->{report_charset} = $1; next; } =item report ...some text for a report... Set the report template which is attached to spam mail messages. See the C<10_misc.cf> configuration file in C for an example. If you change this, try to keep it under 78 columns. Each C line appends to the existing template, so use C to restart. Tags can be included as explained above. =cut if (/^report\b\s*(.*?)\s*$/) { my $report = $1; if ( $report =~ /^"(.*?)"$/ ) { $report = $1; } $self->{report_template} .= "$report\n"; next; } =item clear_report_template Clear the report template. =cut if (/^clear_report_template$/) { $self->{report_template} = ''; next; } =item report_contact ...text of contact address... Set what _CONTACTADDRESS_ is replaced with in the above report text. By default, this is 'the administrator of that system', since the hostname of the system the scanner is running on is also included. =cut if (/^report_contact\s+(.*?)\s*$/) { $self->{report_contact} = $1; next; } =item unsafe_report ...some text for a report... Set the report template which is attached to spam mail messages which contain a non-text/plain part. See the C<10_misc.cf> configuration file in C for an example. Each C line appends to the existing template, so use C to restart. Tags can be used in this template (see above for details). =cut if (/^unsafe_report\b\s*(.*?)$/) { my $report = $1; if ( $report =~ /^"(.*?)"$/ ) { $report = $1; } $self->{unsafe_report_template} .= "$report\n"; next; } =item clear_unsafe_report_template Clear the unsafe_report template. =cut if (/^clear_unsafe_report_template$/) { $self->{unsafe_report_template} = ''; next; } =item spamtrap ...some text for spamtrap reply mail... A template for spam-trap responses. If the first few lines begin with C where Xxxxxx is a header and yyy is some text, they'll be used as headers. See the C<10_misc.cf> configuration file in C for an example. Unfortunately tags can not be used with this option. =cut if (/^spamtrap\s*(.*?)$/) { my $report = $1; if ( $report =~ /^"(.*?)"$/ ) { $report = $1; } $self->{spamtrap_template} .= "$report\n"; next; } =item clear_spamtrap_template Clear the spamtrap template. =cut if (/^clear_spamtrap_template$/) { $self->{spamtrap_template} = ''; next; } =item describe SYMBOLIC_TEST_NAME description ... Used to describe a test. This text is shown to users in the detailed report. Note that test names which begin with '__' are reserved for meta-match sub-rules, and are not scored or listed in the 'tests hit' reports. Also note that by convention, rule descriptions should be limited in length to no more than 50 characters. =cut if (/^describe\s+(\S+)\s+(.*)$/) { $self->{descriptions}->{$1} = $2; next; } =back =head2 LANGUAGE OPTIONS =over 4 =item ok_languages xx [ yy zz ... ] (default: all) This option is used to specify which languages are considered OK for incoming mail. SpamAssassin will try to detect the language used in the message text. Note that the language cannot always be recognized with sufficient confidence. In that case, no points will be assigned. The rule C is triggered based on how this is set. In your configuration, you must use the two or three letter language specifier in lowercase, not the English name for the language. You may also specify C if a desired language is not listed, or if you want to allow any language. The default setting is C. Examples: ok_languages all (allow all languages) ok_languages en (only allow English) ok_languages en ja zh (allow English, Japanese, and Chinese) Note: if there are multiple ok_languages lines, only the last one is used. Select the languages to allow from the list below: =over 4 =item af - Afrikaans =item am - Amharic =item ar - Arabic =item be - Byelorussian =item bg - Bulgarian =item bs - Bosnian =item ca - Catalan =item cs - Czech =item cy - Welsh =item da - Danish =item de - German =item el - Greek =item en - English =item eo - Esperanto =item es - Spanish =item et - Estonian =item eu - Basque =item fa - Persian =item fi - Finnish =item fr - French =item fy - Frisian =item ga - Irish Gaelic =item gd - Scottish Gaelic =item he - Hebrew =item hi - Hindi =item hr - Croatian =item hu - Hungarian =item hy - Armenian =item id - Indonesian =item is - Icelandic =item it - Italian =item ja - Japanese =item ka - Georgian =item ko - Korean =item la - Latin =item lt - Lithuanian =item lv - Latvian =item mr - Marathi =item ms - Malay =item ne - Nepali =item nl - Dutch =item no - Norwegian =item pl - Polish =item pt - Portuguese =item qu - Quechua =item rm - Rhaeto-Romance =item ro - Romanian =item ru - Russian =item sa - Sanskrit =item sco - Scots =item sk - Slovak =item sl - Slovenian =item sq - Albanian =item sr - Serbian =item sv - Swedish =item sw - Swahili =item ta - Tamil =item th - Thai =item tl - Tagalog =item tr - Turkish =item uk - Ukrainian =item vi - Vietnamese =item yi - Yiddish =item zh - Chinese =back =cut if (/^ok_languages\s+(.+)$/) { $self->{ok_languages} = $1; next; } =back Z<> =over 4 =item ok_locales xx [ yy zz ... ] (default: all) This option is used to specify which locales (country codes) are considered OK for incoming mail. Mail using B used by languages in these countries will not be marked as possibly being spam in a foreign language. If you receive lots of spam in foreign languages, and never get any non-spam in these languages, this may help. Note that all ISO-8859-* character sets, and Windows code page character sets, are always permitted by default. Set this to C to allow all character sets. This is the default. The rules C, C, and C are triggered based on how this is set. Examples: ok_locales all (allow all locales) ok_locales en (only allow English) ok_locales en ja zh (allow English, Japanese, and Chinese) Note: if there are multiple ok_locales lines, only the last one is used. Select the locales to allow from the list below: =over 4 =item en - Western character sets in general =item ja - Japanese character sets =item ko - Korean character sets =item ru - Cyrillic character sets =item th - Thai character sets =item zh - Chinese (both simplified and traditional) character sets =back =cut if (/^ok_locales\s+(.+)$/) { $self->{ok_locales} = $1; next; } =back =head2 NETWORK TEST OPTIONS =over 4 =item use_dcc ( 0 | 1 ) (default: 1) Whether to use DCC, if it is available. =cut if (/^use_dcc\s+(\d+)$/) { $self->{use_dcc} = $1; next; } =item dcc_timeout n (default: 10) How many seconds you wait for dcc to complete before you go on without the results =cut if (/^dcc_timeout\s+(\d+)$/) { $self->{dcc_timeout} = $1+0; next; } =item dcc_body_max NUMBER =item dcc_fuz1_max NUMBER =item dcc_fuz2_max NUMBER DCC (Distributed Checksum Clearinghouse) is a system similar to Razor. This option sets how often a message's body/fuz1/fuz2 checksum must have been reported to the DCC server before SpamAssassin will consider the DCC check as matched. As nearly all DCC clients are auto-reporting these checksums you should set this to a relatively high value, e.g. 999999 (this is DCC's MANY count). The default is 999999 for all these options. =cut if (/^dcc_body_max\s+(\d+)/) { $self->{dcc_body_max} = $1+0; next; } if (/^dcc_fuz1_max\s+(\d+)/) { $self->{dcc_fuz1_max} = $1+0; next; } if (/^dcc_fuz2_max\s+(\d+)/) { $self->{dcc_fuz2_max} = $1+0; next; } =item use_pyzor ( 0 | 1 ) (default: 1) Whether to use Pyzor, if it is available. =cut if (/^use_pyzor\s+(\d+)$/) { $self->{use_pyzor} = $1; next; } =item pyzor_timeout n (default: 10) How many seconds you wait for Pyzor to complete before you go on without the results. =cut if (/^pyzor_timeout\s+(\d+)$/) { $self->{pyzor_timeout} = $1+0; next; } =item pyzor_max NUMBER Pyzor is a system similar to Razor. 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. The default is 5. =cut if (/^pyzor_max\s+(\d+)/) { $self->{pyzor_max} = $1+0; next; } =item pyzor_options options Specify options to the pyzor command. Please note that only [A-Za-z0-9 -/] is allowed (security). =cut if (/^pyzor_options\s+([A-Za-z0-9 -\/]+)/) { $self->{pyzor_options} = $1; next; } =item trusted_networks ip.add.re.ss[/mask] ... (default: none) What networks or hosts are 'trusted' in your setup. B in this case means that relay hosts on these networks are considered to not be potentially operated by spammers, open relays, or open proxies. DNS blacklist checks will never query for hosts on these networks. If a C is specified, it's considered a CIDR-style 'netmask', specified in bits. If it is not specified, but less than 4 octets are specified with a trailing dot, that's considered a mask to allow all addresses in the remaining octets. If a mask is not specified, and there is not trailing dot, then just the single IP address specified is used, as if the mask was C. Examples: trusted_networks 192.168/16 127/8 # all in 192.168.*.* and 127.*.*.* trusted_networks 212.17.35.15 # just that host trusted_networks 127. # all in 127.*.*.* This operates additively, so a C line after another one will result in all those networks becoming trusted. To clear out the existing entries, use C. If you're running with DNS checks enabled, SpamAssassin includes code to infer your trusted networks on the fly, so this may not be necessary. (Thanks to Scott Banister and Andrew Flury for the inspiration for this algorithm.) This inference works as follows: =over 4 =item * if the 'from' IP address is on the same /16 network as the top Received line's 'by' host, it's trusted =item * if the address of the 'from' host is in a reserved network range, then it's trusted =item * if any addresses of the 'by' host is in a reserved network range, then it's trusted =back =cut if (/^trusted_networks\s+(.+)$/) { foreach my $net (split (' ', $1)) { $self->{trusted_networks}->add_cidr ($net); } next; } =item clear_trusted_networks Empty the list of trusted networks. =cut if (/^clear_trusted_networks$/) { $self->{trusted_networks} = Mail::SpamAssassin::NetSet->new(); next; } =item use_razor2 ( 0 | 1 ) (default: 1) Whether to use Razor version 2, if it is available. =cut if (/^use_razor2\s+(\d+)$/) { $self->{use_razor2} = $1; next; } =item razor_timeout n (default: 10) How many seconds you wait for razor to complete before you go on without the results =cut if (/^razor_timeout\s+(\d+)$/) { $self->{razor_timeout} = $1; next; } =item use_bayes ( 0 | 1 ) (default: 1) Whether to use the naive-Bayesian-style classifier built into SpamAssassin. =cut if (/^use_bayes\s+(\d+)$/) { $self->{use_bayes} = $1; next; } =item skip_rbl_checks { 0 | 1 } (default: 0) By default, SpamAssassin will run RBL checks. If your ISP already does this for you, set this to 1. =cut if (/^skip_rbl_checks\s+(\d+)$/) { $self->{skip_rbl_checks} = $1+0; next; } =item rbl_timeout n (default: 15) All RBL queries are made at the beginning of a check and we try to read the results at the end. This value specifies the maximum period of time to wait for an RBL query. If most of the RBL queries have succeeded for a particular message, then SpamAssassin will not wait for the full period to avoid wasting time on unresponsive server(s). For the default 15 second timeout, here is a chart of queries remaining versus the effective timeout in seconds: queries left 100% 90% 80% 70% 60% 50% 40% 30% 20% 10% 0% timeout 15 15 14 14 13 11 10 8 5 3 0 In addition, whenever the effective timeout is lowered due to additional query results returning, the remaining queries are always given at least one more second before timing out, but the wait time will never exceed rbl_timeout. For example, if 20 queries are made at the beginning of a message check and 16 queries have returned (leaving 20%), the remaining 4 queries must finish within 5 seconds of the beginning of the check or they will be timed out. =cut if (/^rbl_timeout\s+(\d+)$/) { $self->{rbl_timeout} = $1+0; next; } =item check_mx_attempts n (default: 2) By default, SpamAssassin checks the From: address for a valid MX this many times, waiting 5 seconds each time. =cut if (/^check_mx_attempts\s+(\S+)$/) { $self->{check_mx_attempts} = $1+0; next; } =item check_mx_delay n (default: 5) How many seconds to wait before retrying an MX check. =cut if (/^check_mx_delay\s+(\S+)$/) { $self->{check_mx_delay} = $1+0; next; } =item dns_available { yes | test[: name1 name2...] | no } (default: test) By default, SpamAssassin will query some default hosts on the internet to attempt to check if DNS is working on not. The problem is that it can introduce some delay if your network connection is down, and in some cases it can wrongly guess that DNS is unavailable because the test connections failed. SpamAssassin includes a default set of 13 servers, among which 3 are picked randomly. You can however specify your own list by specifying dns_available test: server1.tld server2.tld server3.tld Please note, the DNS test queries for MX records so if you specify your own list of servers, please make sure to choose the one(s) which has an associated MX record. =cut if (/^dns_available\s+(yes|no|test|test:\s+.+)$/) { $self->{dns_available} = ($1 or "test"); next; } =back =head2 LEARNING OPTIONS =over 4 =item auto_whitelist_factor n (default: 0.5, range [0..1]) How much towards the long-term mean for the sender to regress a message. Basically, the algorithm is to track the long-term mean score of messages for the sender (C), and then once we have otherwise fully calculated the score for this message (C), we calculate the final score for the message as: C = C + (C - C) * C So if C = 0.5, then we'll move to half way between the calculated score and the mean. If C = 0.3, then we'll move about 1/3 of the way from the score toward the mean. C = 1 means just use the long-term mean; C = 0 mean just use the calculated score. =cut if (/^auto_whitelist_factor\s+(.*)$/) { $self->{auto_whitelist_factor} = $1; next; } =item bayes_auto_learn ( 0 | 1 ) (default: 1) Whether SpamAssassin should automatically feed high-scoring mails (or low-scoring mails, for non-spam) into its learning systems. The only learning system supported currently is a naive-Bayesian-style classifier. Note that certain tests are ignored when determining whether a message should be trained upon: - auto-whitelist (AWL) - rules with tflags set to 'learn' (the Bayesian rules) - rules with tflags set to 'userconf' (user white/black-listing rules, etc) Also note that auto-training occurs using scores from either scoreset 0 or 1, depending on what scoreset is used during message check. It is likely that the message check and auto-train scores will be different. =cut if (/^(?:bayes_)?auto_learn\s+(.*)$/) { $self->{bayes_auto_learn} = $1+0; next; } =item bayes_auto_learn_threshold_nonspam n.nn (default: 0.1) The score threshold below which a mail has to score, to be fed into SpamAssassin's learning systems automatically as a non-spam message. =cut if (/^(?:bayes_)?auto_learn_threshold_nonspam\s+(.*)$/) { $self->{bayes_auto_learn_threshold_nonspam} = $1+0; next; } =item bayes_auto_learn_threshold_spam n.nn (default: 12.0) The score threshold above which a mail has to score, to be fed into SpamAssassin's learning systems automatically as a spam message. Note: SpamAssassin requires at least 3 points from the header, and 3 points from the body to auto-learn as spam. Therefore, the minimum working value for this option is 6. =cut if (/^(?:bayes_)?auto_learn_threshold_spam\s+(.*)$/) { $self->{bayes_auto_learn_threshold_spam} = $1+0; next; } =item bayes_ignore_header header_name If you receive mail filtered by upstream mail systems, like a spam-filtering ISP or mailing list, and that service adds new headers (as most of them do), these headers may provide inappropriate cues to the Bayesian classifier, allowing it to take a "short cut". To avoid this, list the headers using this setting. Example: bayes_ignore_header X-Upstream-Spamfilter bayes_ignore_header X-Upstream-SomethingElse =cut if (/^bayes_ignore_header\s+(.*)$/) { push (@{$self->{bayes_ignore_headers}}, $1); next; } =item bayes_min_ham_num (Default: 200) =item bayes_min_spam_num (Default: 200) To be accurate, the Bayes system does not activate until a certain number of ham (non-spam) and spam have been learned. The default is 200 of each ham and spam, but you can tune these up or down with these two settings. =cut if (/^bayes_min_ham_num\s+(.*)$/) { $self->{bayes_min_ham_num} = $1+0; next; } if (/^bayes_min_spam_num\s+(.*)$/) { $self->{bayes_min_spam_num} = $1+0; next; } =item bayes_learn_during_report (Default: 1) The Bayes system will, by default, learn any reported messages (C) as spam. If you do not want this to happen, set this option to 0. =cut if (/^bayes_learn_during_report\s+(.*)$/) { $self->{bayes_learn_during_report} = $1+0; next; } =back =head2 DEPRECATED OPTIONS =over 4 =item always_add_headers { 0 | 1 } (default: 1) By default, B and B) will be added to all messages scanned by SpamAssassin. If you don't want to add those headers to non-spam, set this value to 0. This option is deprecated in version 2.60 and later. It will be removed in a future version. Instead, use the B and B options to customize headers. =cut if (/^always_add_headers\s+(\d+)$/) { if ($1 == 0) { for my $name (keys %{ $self->{headers_ham} }) { delete $self->{headers_ham}->{$name} if $name ne "Checker-Version"; } } else { $self->add_default_ham_headers(); } next; } =item always_add_report { 0 | 1 } (default: 0) When the B option is turned off, mail tagged as spam will include a report in a header named B. If you set B to C<1>, the report will also be included in the B header for non-spam mail. This option is deprecated in version 2.60 and later. It will be removed in a future version. Please use the flexible B option instead: add_header all Report _REPORT_ =cut if (/^always_add_report\s+(\d+)$/) { if ($1 == 0) { delete $self->{headers_ham}->{"Report"}; } else { $self->{headers_ham}->{"Report"} = "_REPORT_"; } next; } =item spam_level_stars { 0 | 1 } (default: 1) By default, a header field called "X-Spam-Level" will be added to the message, with its value set to a number of asterisks equal to the score of the message. In other words, for a message scoring 7.2 points: X-Spam-Level: ******* This can be useful for MUA rule creation. Note that a maximum of 50 'stars' will be added, to keep under RFC-822's message header line length limit. This option is deprecated in version 2.60 and later. It will be removed in a future version. Please use the add_header option instead: add_header all Level _STARS(*)_ =cut if(/^spam_level_stars\s+(\d+)$/) { if ($1 == 0) { delete $self->{headers_ham}->{"Level"}; delete $self->{headers_spam}->{"Level"}; } next; } =item spam_level_char { x (some character, unquoted) } (default: *) By default, the "X-Spam-Level" header will use a '*' character with its length equal to the score of the message. Some people don't like escaping *s though, so you can set the character to anything with this option. In other words, for a message scoring 7.2 points with this option set to . X-Spam-Level: ....... This option is deprecated in version 2.60 and later. It will be removed in a future version. Please use the add_header option instead: add_header all Level _STARS(.)_ =cut if(/^spam_level_char\s+(.)$/) { $self->{headers_ham}->{"Level"} = "_STARS($1)_"; $self->{headers_spam}->{"Level"} = "_STARS($1)_"; next; } =item dcc_add_header { 0 | 1 } (default: 0) DCC processing creates a message header containing the statistics for the message. This option sets whether SpamAssassin will add the heading to messages it processes. The default is to not add the header. This option is deprecated in version 2.60 and later. It will be removed in a future version. Please use the add_header option instead: add_header all DCC _DCCB_: _DCCR_ =cut if (/^dcc_add_header\s+(\d+)$/) { if ($1 == 1) { $self->{headers_spam}->{"DCC"} = "_DCCB_: _DCCR_"; $self->{headers_ham}->{"DCC"} = $self->{headers_spam}->{"DCC"}; } next; } =item pyzor_add_header { 0 | 1 } (default: 0) Pyzor processing creates a message header containing the statistics for the message. This option sets whether SpamAssassin will add the heading to messages it processes. The default is to not add the header. This option is deprecated in version 2.60 and later. It will be removed in a future version. Please use the add_header option instead: add_header all Pyzor _PYZOR_ =cut if (/^pyzor_add_header\s+(\d+)$/) { if ($1 == 1) { $self->{headers_spam}->{"Pyzor"} = "_PYZOR_"; $self->{headers_ham}->{"Pyzor"} = "_PYZOR_"; } next; } =item num_check_received { integer } (default: 9) How many received lines from and including the original mail relay do we check in RBLs (at least 1 or 2 is recommended). Note that for checking against dialup lists, you can call C with a special set name of B and this rule will only be matched against the relays except for the very first one; this allows SpamAssassin to catch dialup-sent spam, without penalizing people who properly relay through their ISP. This option is deprecated in version 2.60 and later. It will be removed in a future version. Please use the C option instead (it is a much better way to control DNSBL-checking behaviour). =cut if (/^num_check_received\s+(\d+)$/) { $self->{num_check_received} = $1+0; next; } =item use_terse_report { 0 | 1 } (default: 1) This option is deprecated and does nothing. It will be removed in a future version. =cut if (/^use_terse_report\s+(\d+)$/) { next; } =item terse_report ...some text for a report... This option is deprecated and does nothing. It will be removed in a future version. =cut if (/^terse_report\b\s*(.*?)$/) { next; } =item clear_terse_report_template This option is deprecated and does nothing. It will be removed in a future version. =cut if (/^clear_terse_report_template$/) { next; } ########################################################################### # SECURITY: no eval'd code should be loaded before this line. # if ($scoresonly && !$self->{allow_user_rules}) { goto failed_line; } if ($scoresonly) { dbg("Checking privileged commands in user config"); } =back =head1 PRIVILEGED SETTINGS These settings differ from the ones above, in that they are considered 'privileged'. Only users running C from their procmailrc's or forward files, or sysadmins editing a file in C, can use them. C users cannot use them in their C files, for security and efficiency reasons, unless allow_user_rules is enabled (and then, they may only add rules from below). =over 4 =item allow_user_rules { 0 | 1 } (default: 0) This setting allows users to create rules (and only rules) in their C files for use with C. It defaults to off, because this could be a severe security hole. It may be possible for users to gain root level access if C is run as root. It is NOT a good idea, unless you have some other way of ensuring that users' tests are safe. Don't use this unless you are certain you know what you are doing. Furthermore, this option causes spamassassin to recompile all the tests each time it processes a message for a user with a rule in his/her C file, which could have a significant effect on server load. It is not recommended. Note that it is not currently possible to use C to modify an existing system rule from a C file with C. =cut if (/^allow_user_rules\s+(\d+)$/) { $self->{allow_user_rules} = $1+0; dbg( ($self->{allow_user_rules} ? "Allowing":"Not allowing") . " user rules!"); next; } =item header SYMBOLIC_TEST_NAME header op /pattern/modifiers [if-unset: STRING] Define a test. C is a symbolic test name, such as 'FROM_ENDS_IN_NUMS'. C
is the name of a mail header, such as 'Subject', 'To', etc. 'ALL' can be used to mean the text of all the message's headers. 'ToCc' can be used to mean the contents of both the 'To' and 'Cc' headers. 'MESSAGEID' is a symbol meaning all Message-Id's found in the message; some mailing list software moves the I Message-Id to 'Resent-Message-Id' or 'X-Message-Id', then uses its own one in the 'Message-Id' header. The value returned for this symbol is the text from all 3 headers, separated by newlines. C is either C<=~> (contains regular expression) or C (does not contain regular expression), and C is a valid Perl regular expression, with C as regexp modifiers in the usual style. Note that multi-line rules are not supported, even if you use C as a modifier. If the C<[if-unset: STRING]> tag is present, then C will be used if the header is not found in the mail message. Test names should not start with a number, and must contain only alphanumerics and underscores. It is suggested that lower-case characters not be used, as an informal convention. Dashes are not allowed. Note that test names which begin with '__' are reserved for meta-match sub-rules, and are not scored or listed in the 'tests hit' reports. Test names which begin with 'T_' are reserved for tests which are undergoing QA, and these are given a very low score. If you add or modify a test, please be sure to run a sanity check afterwards by running C. This will avoid confusing error messages, or other tests being skipped as a side-effect. =item header SYMBOLIC_TEST_NAME exists:name_of_header Define a header existence test. C is the name of a header to test for existence. This is just a very simple version of the above header tests. =item header SYMBOLIC_TEST_NAME eval:name_of_eval_method([arguments]) Define a header eval test. C is the name of a method on the C object. C are optional arguments to the function call. =item header SYMBOLIC_TEST_NAME eval:check_rbl('set', 'zone') Check a DNSBL (DNS blacklist), also known as RBLs (realtime blacklists). This will retrieve Received headers from the mail, parse the IP addresses, select which ones are 'untrusted' based on the C logic, and query that blacklist. There's a few things to note: =over 4 =item Duplicated or reserved IPs These are stripped, and the DNSBLs will not be queried for them. Reserved IPs are those listed in , , or . =item The first argument, 'set' This is used as a 'zone ID'. If you want to look up a multi-meaning zone like relays.osirusoft.com, you can then query the results from that zone using it; but all check_rbl_sub() calls must use that zone ID. Also, if an IP gets a hit in one lookup in a zone using that ID, any further hits in other rules using that zone ID will *not* be added to the score. =item Selecting all IPs except for the originating one This is accomplished by naming the set 'foo-notfirsthop'. Useful for querying against DNS lists which list dialup IP addresses; the first hop may be a dialup, but as long as there is at least one more hop, via their outgoing SMTP server, that's legitimate, and so should not gain points. If there is only one hop, that will be queried anyway, as it should be relaying via its outgoing SMTP server instead of sending directly to your MX. =item Selecting IPs by whether they are trusted When checking a 'nice' DNSBL (a DNS whitelist), you cannot trust the IP addresses in Received headers that were not added by trusted relays. To test the first IP address that can be trusted, name the set 'foo-firsttrusted'. That should test the IP address of the relay that connected to the most remote trusted relay. In addition, you can test all untrusted IP addresses by naming the set 'foo-untrusted'. Note that this requires that SpamAssassin know which relays are trusted. For simple cases, SpamAssassin can make a good estimate. For complex cases, you may get better results by setting C manually. =back =item header SYMBOLIC_TEST_NAME eval:check_rbl_txt('set', 'zone') Same as check_rbl(), except querying using IN TXT instead of IN A records. If the zone supports it, it will result in a line of text describing why the IP is listed, typically a hyperlink to a database entry. =item header SYMBOLIC_TEST_NAME eval:check_rbl_sub('set', 'sub-test') Create a sub-test for 'set'. If you want to look up a multi-meaning zone like relays.osirusoft.com, you can then query the results from that zone using the zone ID from the original query. The sub-test may either be an IPv4 dotted address for RBLs that return multiple A records or a non-negative decimal number to specify a bitmask for RBLs that return a single A record containing a bitmask of results. =cut if (/^header\s+(\S+)\s+(?:rbl)?eval:(.*)$/) { my ($name, $fn) = ($1, $2); if ($fn =~ /^check_rbl/) { $self->add_test ($name, $fn, TYPE_RBL_EVALS); } else { $self->add_test ($name, $fn, TYPE_HEAD_EVALS); } next; } if (/^header\s+(\S+)\s+exists:(.*)$/) { $self->add_test ($1, "$2 =~ /./", TYPE_HEAD_TESTS); $self->{descriptions}->{$1} = "Found a $2 header"; next; } if (/^header\s+(\S+)\s+(.*)$/) { $self->add_test ($1, $2, TYPE_HEAD_TESTS); next; } =item body SYMBOLIC_TEST_NAME /pattern/modifiers Define a body pattern test. C is a Perl regular expression. The 'body' in this case is the textual parts of the message body; any non-text MIME parts are stripped, and the message decoded from Quoted-Printable or Base-64-encoded format if necessary. The message Subject header is considered part of the body and becomes the first paragraph when running the rules. All HTML tags and line breaks will be removed before matching. =item body SYMBOLIC_TEST_NAME eval:name_of_eval_method([args]) Define a body eval test. See above. =cut if (/^body\s+(\S+)\s+eval:(.*)$/) { $self->add_test ($1, $2, TYPE_BODY_EVALS); next; } if (/^body\s+(\S+)\s+(.*)$/) { $self->add_test ($1, $2, TYPE_BODY_TESTS); next; } =item uri SYMBOLIC_TEST_NAME /pattern/modifiers Define a uri pattern test. C is a Perl regular expression. The 'uri' in this case is a list of all the URIs in the body of the email, and the test will be run on each and every one of those URIs, adjusting the score if a match is found. Use this test instead of one of the body tests when you need to match a URI, as it is more accurately bound to the start/end points of the URI, and will also be faster. =cut # we don't do URI evals yet - maybe later # if (/^uri\s+(\S+)\s+eval:(.*)$/) { # $self->add_test ($1, $2, TYPE_URI_EVALS); # next; # } if (/^uri\s+(\S+)\s+(.*)$/) { $self->add_test ($1, $2, TYPE_URI_TESTS); next; } =item rawbody SYMBOLIC_TEST_NAME /pattern/modifiers Define a raw-body pattern test. C is a Perl regular expression. The 'raw body' of a message is the text, including all textual parts. The text will be decoded from base64 or quoted-printable encoding, but HTML tags and line breaks will still be present. =item rawbody SYMBOLIC_TEST_NAME eval:name_of_eval_method([args]) Define a raw-body eval test. See above. =cut if (/^rawbody\s+(\S+)\s+eval:(.*)$/) { $self->add_test ($1, $2, TYPE_RAWBODY_EVALS); next; } if (/^rawbody\s+(\S+)\s+(.*)$/) { $self->add_test ($1, $2, TYPE_RAWBODY_TESTS); next; } =item full SYMBOLIC_TEST_NAME /pattern/modifiers Define a full-body pattern test. C is a Perl regular expression. The 'full body' of a message is the un-decoded text, including all parts (including images or other attachments). SpamAssassin no longer tests full tests against decoded text; use C for that. =item full SYMBOLIC_TEST_NAME eval:name_of_eval_method([args]) Define a full-body eval test. See above. =cut if (/^full\s+(\S+)\s+eval:(.*)$/) { $self->add_test ($1, $2, TYPE_FULL_EVALS); next; } if (/^full\s+(\S+)\s+(.*)$/) { $self->add_test ($1, $2, TYPE_FULL_TESTS); next; } =item meta SYMBOLIC_TEST_NAME boolean expression Define a boolean expression test in terms of other tests that have been hit or not hit. For example: meta META1 TEST1 && !(TEST2 || TEST3) Note that English language operators ("and", "or") will be treated as rule names, and that there is no C operator. =item meta SYMBOLIC_TEST_NAME boolean arithmetic expression Can also define a boolean arithmetic expression in terms of other tests, with a hit test having the value "1" and an unhit test having the value "0". For example: meta META2 (3 * TEST1 - 2 * TEST2) > 0 Note that Perl builtins and functions, like C, B be used, and will be treated as rule names. If you want to define a meta-rule, but do not want its individual sub-rules to count towards the final score unless the entire meta-rule matches, give the sub-rules names that start with '__' (two underscores). SpamAssassin will ignore these for scoring. =cut if (/^meta\s+(\S+)\s+(.*)$/) { $self->add_test ($1, $2, TYPE_META_TESTS); next; } =item tflags SYMBOLIC_TEST_NAME [ { net | nice | learn | userconf } ... ] Used to set flags on a test. These flags are used in the score-determination back end system for details of the test's behaviour. The following flags can be set: =over 4 =item net The test is a network test, and will not be run in the mass checking system or if B<-L> is used, therefore its score should not be modified. =item nice The test is intended to compensate for common false positives, and should be assigned a negative score. =item userconf The test requires user configuration before it can be used (like language- specific tests). =item learn The test requires training before it can be used. =back =cut if (/^tflags\s+(\S+)\s+(.+)$/) { $self->{tflags}->{$1} = $2; next; next; # ignored in SpamAssassin modules } ########################################################################### # SECURITY: allow_user_rules is only in affect until here. # if ($scoresonly) { goto failed_line; } =back =head1 ADMINISTRATOR SETTINGS These settings differ from the ones above, in that they are considered 'more privileged' -- even more than the ones in the SETTINGS section. No matter what C is set to, these can never be set from a user's C file. =over 4 =item test SYMBOLIC_TEST_NAME (ok|fail) Some string to test against Define a regression testing string. You can have more than one regression test string per symbolic test name. Simply specify a string that you wish the test to match. These tests are only run as part of the test suite - they should not affect the general running of SpamAssassin. =cut if (/^test\s+(\S+)\s+(ok|fail)\s+(.*)$/) { $self->add_regression_test($1, $2, $3); next; } =item razor_config filename Define the filename used to store Razor's configuration settings. Currently this is left to Razor to decide. =cut if (/^razor_config\s+(.*)$/) { $self->{razor_config} = $1; next; } =item pyzor_path STRING This option tells SpamAssassin specifically where to find the C client instead of relying on SpamAssassin to find it in the current PATH. Note that if I is enabled in the Perl interpreter, you should use this, as the current PATH will have been cleared. =cut if (/^pyzor_path\s+(.+)$/) { $self->{pyzor_path} = $1; next; } =item dcc_home STRING This option tells SpamAssassin specifically where to find the dcc homedir. If C is not specified, it will default to looking in C for dcc client instead of relying on SpamAssassin to find it in the current PATH. If it isn't found there, it will look in the current PATH. If a C socket is found in C, it will use that interface that instead of C. =cut if (/^dcc[-_]home\s+(.+)$/) { $self->{dcc_home} = $1; next; } =item dcc_dccifd_path STRING This option tells SpamAssassin specifically where to find the dccifd socket. If C is not specified, it will default to looking in C If a C socket is found, it will use it instead of C. =cut if (/^dcc[-_]dccifd[-_]path\s+(.+)$/) { $self->{dcc_dccifd_path} = $1; next; } =item dcc_path STRING This option tells SpamAssassin specifically where to find the C client instead of relying on SpamAssassin to find it in the current PATH. Note that if I is enabled in the Perl interpreter, you should use this, as the current PATH will have been cleared. =cut if (/^dcc_path\s+(.+)$/) { $self->{dcc_path} = $1; next; } =item dcc_options options Specify additional options to the dccproc(8) command. Please note that only [A-Z -] is allowed (security). The default is C<-R> =cut if (/^dcc_options\s+([A-Z -]+)/) { $self->{dcc_options} = $1; next; } =item auto_whitelist_path /path/to/file (default: ~/.spamassassin/auto-whitelist) Automatic-whitelist directory or file. By default, each user has their own, in their C<~/.spamassassin> directory with mode 0700, but for system-wide SpamAssassin use, you may want to share this across all users. =cut if (/^auto_whitelist_path\s+(.*)$/) { $self->{auto_whitelist_path} = $1; next; } =item bayes_path /path/to/file (default: ~/.spamassassin/bayes) Path for Bayesian probabilities databases. Several databases will be created, with this as the base, with C<_toks>, C<_seen> etc. appended to this filename; so the default setting results in files called C<~/.spamassassin/bayes_seen>, C<~/.spamassassin/bayes_toks> etc. By default, each user has their own, in their C<~/.spamassassin> directory with mode 0700/0600, but for system-wide SpamAssassin use, you may want to reduce disk space usage by sharing this across all users. (However it should be noted that Bayesian filtering appears to be more effective with an individual database per user.) =cut if (/^bayes_path\s+(.*)$/) { $self->{bayes_path} = $1; next; } =item auto_whitelist_file_mode (default: 0700) The file mode bits used for the automatic-whitelist directory or file. Make sure you specify this using the 'x' mode bits set, as it may also be used to create directories. However, if a file is created, the resulting file will not have any execute bits set (the umask is set to 111). =cut if (/^auto_whitelist_file_mode\s+(.*)$/) { $self->{auto_whitelist_file_mode} = $1; next; } =item bayes_file_mode (default: 0700) The file mode bits used for the Bayesian filtering database files. Make sure you specify this using the 'x' mode bits set, as it may also be used to create directories. However, if a file is created, the resulting file will not have any execute bits set (the umask is set to 111). =cut if (/^bayes_file_mode\s+(.*)$/) { $self->{bayes_file_mode} = $1; next; } =item bayes_use_hapaxes (default: 1) Should the Bayesian classifier use hapaxes (words/tokens that occur only once) when classifying? This produces significantly better hit-rates, but increases database size by about a factor of 8 to 10. =cut if (/^bayes_use_hapaxes\s+(.*)$/) { $self->{bayes_use_hapaxes} = $1; next; } =item bayes_use_chi2_combining (default: 1) Should the Bayesian classifier use chi-squared combining, instead of Robinson/Graham-style naive Bayesian combining? Chi-squared produces more 'extreme' output results, but may be more resistant to changes in corpus size etc. =cut if (/^bayes_use_chi2_combining\s+(.*)$/) { $self->{bayes_use_chi2_combining} = $1; next; } =item bayes_journal_max_size (default: 102400) SpamAssassin will opportunistically sync the journal and the database. It will do so once a day, but will sync more often if the journal file size goes above this setting, in bytes. If set to 0, opportunistic syncing will not occur. =cut if (/^bayes_journal_max_size\s+(\d+)$/) { $self->{bayes_journal_max_size} = $1; next; } =item bayes_expiry_max_db_size (default: 150000) What should be the maximum size of the Bayes tokens database? When expiry occurs, the Bayes system will keep either 75% of the maximum value, or 100,000 tokens, whichever has a larger value. 150,000 tokens is roughly equivalent to a 8Mb database file. =cut if (/^bayes_expiry_max_db_size\s+(\d+)$/) { $self->{bayes_expiry_max_db_size} = $1; next; } =item bayes_auto_expire (default: 1) If enabled, the Bayes system will try to automatically expire old tokens from the database. Auto-expiry occurs when the number of tokens in the database surpasses the bayes_expiry_max_db_size value. =cut if (/^bayes_auto_expire\s+(\d+)$/) { $self->{bayes_auto_expire} = $1; next; } =item bayes_learn_to_journal (default: 0) If this option is set, whenever SpamAssassin does Bayes learning, it will put the information into the journal instead of directly into the database. This lowers contention for locking the database to execute an update, but will also cause more access to the journal and cause a delay before the updates are actually committed to the Bayes database. =cut if (/^bayes_learn_to_journal\s+(.*)$/) { $self->{bayes_learn_to_journal} = $1+0; next; } =item user_scores_dsn DBI:databasetype:databasename:hostname:port If you load user scores from an SQL database, this will set the DSN used to connect. Example: C =cut if (/^user_scores_dsn\s+(\S+)$/) { $self->{user_scores_dsn} = $1; next; } =item user_scores_sql_username username The authorized username to connect to the above DSN. =cut if(/^user_scores_sql_username\s+(\S+)$/) { $self->{user_scores_sql_username} = $1; next; } =item user_scores_sql_password password The password for the database username, for the above DSN. =cut if(/^user_scores_sql_password\s+(\S+)$/) { $self->{user_scores_sql_password} = $1; next; } =item user_scores_sql_table tablename The table user preferences are stored in, for the above DSN. =cut if(/^user_scores_sql_table\s+(\S+)$/) { $self->{user_scores_sql_table} = $1; next; } # Michael 'Moose' Dinn # For integration with horde preferences system # 20020831 =item user_scores_sql_field_username field_username The field that the username whose preferences you're looking up is stored in. Default: C. =cut if(/^user_scores_sql_field_username\s+(\S+)$/) { $self->{user_scores_sql_field_username} = $1; next; } =item user_scores_sql_field_preference field_preference The name of the preference that you're looking for. Default: C. =cut if(/^user_scores_sql_field_preference\s+(\S+)$/) { $self->{user_scores_sql_field_preference} = $1; next; } =item user_scores_sql_field_value field_value The name of the value you're looking for. Default: C. =cut if(/^user_scores_sql_field_value\s+(\S+)$/) { $self->{user_scores_sql_field_value} = $1; next; } =item user_scores_sql_field_scope field_scope The 'scope' field. In Horde this makes the preference a single-module preference or a global preference. There's no real need to change it in other systems. Default: C. =cut if(/^user_scores_sql_field_scope\s+(\S+)$/) { $self->{user_scores_sql_field_scope} = $1; next; } ########################################################################### failed_line: my $msg = "Failed to parse line in SpamAssassin configuration, ". "skipping: $_"; if ($self->{lint_rules}) { warn $msg."\n"; } else { dbg ($msg); } $self->{errors}++; } delete $self->{scoresonly}; } sub add_test { my ($self, $name, $text, $type) = @_; $self->{tests}->{$name} = $text; $self->{test_types}->{$name} = $type; $self->{tflags}->{$name} ||= ''; $self->{source_file}->{$name} = $self->{currentfile}; if ($self->{scoresonly}) { $self->{user_rules_to_compile}->{$type} = 1; } # All scoresets should have a score defined, so if the one we're in # doesn't, we need to set them all. # TODO? - nice tests should get negative scores if ( ! exists $self->{scores}->{$name} ) { # T_ rules (in a testing probationary period) get low, low scores my $set_score = ($name =~/^T_/) ? 0.01 : 1.0; for my $index (0..3) { $self->{scoreset}->[$index]->{$name} = $set_score; } } } sub add_regression_test { my ($self, $name, $ok_or_fail, $string) = @_; if ($self->{regression_tests}->{$name}) { push @{$self->{regression_tests}->{$name}}, [$ok_or_fail, $string]; } else { # initialize the array, and create one element $self->{regression_tests}->{$name} = [ [$ok_or_fail, $string] ]; } } sub regression_tests { my $self = shift; if (@_ == 1) { # we specified a symbolic name, return the strings my $name = shift; my $tests = $self->{regression_tests}->{$name}; return @$tests; } else { # no name asked for, just return the symbolic names we have tests for return keys %{$self->{regression_tests}}; } } # note: error 70 == SA_SOFTWARE sub finish_parsing { my ($self) = @_; while (my ($name, $text) = each %{$self->{tests}}) { my $type = $self->{test_types}->{$name}; # eval type handling if (($type & 1) == 1) { my @args; if (my ($function, $args) = ($text =~ m/(.*?)\s*\((.*?)\)\s*$/)) { if ($args) { @args = ($args =~ m/['"](.*?)['"]\s*(?:,\s*|$)/g); } unshift(@args, $function); if ($type == TYPE_BODY_EVALS) { $self->{body_evals}->{$name} = \@args; } elsif ($type == TYPE_HEAD_EVALS) { $self->{head_evals}->{$name} = \@args; } elsif ($type == TYPE_RBL_EVALS) { $self->{rbl_evals}->{$name} = \@args; } elsif ($type == TYPE_RAWBODY_EVALS) { $self->{rawbody_evals}->{$name} = \@args; } elsif ($type == TYPE_FULL_EVALS) { $self->{full_evals}->{$name} = \@args; } #elsif ($type == TYPE_URI_EVALS) { # $self->{uri_evals}->{$name} = \@args; #} else { $self->{errors}++; sa_die(70, "unknown type $type for $name: $text"); } } else { $self->{errors}++; sa_die(70, "syntax error for $name: $text"); } } # non-eval tests else { if ($type == TYPE_BODY_TESTS) { $self->{body_tests}->{$name} = $text; } elsif ($type == TYPE_HEAD_TESTS) { $self->{head_tests}->{$name} = $text; } elsif ($type == TYPE_META_TESTS) { $self->{meta_tests}->{$name} = $text; } elsif ($type == TYPE_URI_TESTS) { $self->{uri_tests}->{$name} = $text; } elsif ($type == TYPE_RAWBODY_TESTS) { $self->{rawbody_tests}->{$name} = $text; } elsif ($type == TYPE_FULL_TESTS) { $self->{full_tests}->{$name} = $text; } else { $self->{errors}++; sa_die(70, "unknown type $type for $name: $text"); } } } delete $self->{tests}; # free it up } sub add_to_addrlist { my ($self, $singlelist, @addrs) = @_; foreach my $addr (@addrs) { $addr = lc $addr; my $re = $addr; $re =~ s/[\000\\\(]/_/gs; # paranoia $re =~ s/([^\*\?_a-zA-Z0-9])/\\$1/g; # escape any possible metachars $re =~ tr/?/./; # "?" -> "." $re =~ s/\*/\.\*/g; # "*" -> "any string" $self->{$singlelist}->{$addr} = qr/^${re}$/; } } sub add_to_addrlist_rcvd { my ($self, $listname, $addr, $domain) = @_; $addr = lc $addr; my $re = $addr; $re =~ s/[\000\\\(]/_/gs; # paranoia $re =~ s/([^\*\?_a-zA-Z0-9])/\\$1/g; # escape any possible metachars $re =~ tr/?/./; # "?" -> "." $re =~ s/\*/\.\*/g; # "*" -> "any string" $self->{$listname}->{$addr}{re} = qr/^${re}$/; $self->{$listname}->{$addr}{domain} = $domain; } sub remove_from_addrlist { my ($self, $singlelist, @addrs) = @_; foreach my $addr (@addrs) { delete($self->{$singlelist}->{$addr}); } } sub remove_from_addrlist_rcvd { my ($self, $listname, @addrs) = @_; foreach my $addr (@addrs) { delete($self->{$listname}->{$addr}); } } ########################################################################### sub maybe_header_only { my($self,$rulename) = @_; my $type = $self->{test_types}->{$rulename}; return 0 if (!defined ($type)); if (($type == TYPE_HEAD_TESTS) || ($type == TYPE_HEAD_EVALS)) { return 1; } elsif ($type == TYPE_META_TESTS) { my $tflags = $self->{tflags}->{$rulename}; $tflags ||= ''; if ($tflags =~ m/\bnet\b/i) { return 0; } else { return 1; } } return 0; } sub maybe_body_only { my($self,$rulename) = @_; my $type = $self->{test_types}->{$rulename}; return 0 if (!defined ($type)); if (($type == TYPE_BODY_TESTS) || ($type == TYPE_BODY_EVALS) || ($type == TYPE_URI_TESTS) || ($type == TYPE_URI_EVALS)) { # some rawbody go off of headers... return 1; } elsif ($type == TYPE_META_TESTS) { my $tflags = $self->{tflags}->{$rulename}; $tflags ||= ''; if ($tflags =~ m/\bnet\b/i) { return 0; } else { return 1; } } return 0; } ########################################################################### sub dbg { Mail::SpamAssassin::dbg (@_); } sub sa_die { Mail::SpamAssassin::sa_die (@_); } ########################################################################### 1; __END__ =back =head1 LOCALI[SZ]ATION A line starting with the text C will only be interpreted if the user is in that locale, allowing test descriptions and templates to be set for that language. =head1 SEE ALSO C C C =cut