Mail::SpamAssassin::Plugin::ASN(3pm)

1Mail::SpamAssassin::PluUgsienr::CAoSnNt(r3i)buted Perl DMoaciulm:e:nStpaatmiAosnsassin::Plugin::ASN(3)
2
3
4

NAME

6       Mail::SpamAssassin::Plugin::ASN - SpamAssassin plugin to look up the
7       Autonomous System Number (ASN) of the connecting IP address.
8

SYNOPSIS

10        loadplugin Mail::SpamAssassin::Plugin::ASN
11
12        asn_lookup asn.routeviews.org _ASN_ _ASNCIDR_
13
14        add_header all ASN _ASN_ _ASNCIDR_
15

DESCRIPTION

17       This plugin uses DNS lookups to the services of an external DNS zone
18       such as at "http://www.routeviews.org/" to do the actual work. Please
19       make sure that your use of the plugin does not overload their
20       infrastructure - this generally means that you should not use this
21       plugin in a high-volume environment or that you should use a local
22       mirror of the zone (see "ftp://ftp.routeviews.org/dnszones/").  Other
23       similar zones may also be used.
24

TEMPLATE TAGS

26       This plugin allows you to create template tags containing the
27       connecting IP's AS number and route info for that AS number.
28
29       The default config will add a header field that looks like this:
30
31        X-Spam-ASN: AS24940 213.239.192.0/18
32
33       where "24940" is the ASN and "213.239.192.0/18" is the route announced
34       by that ASN where the connecting IP address came from.  If the AS
35       announces multiple networks (more/less specific), they will all be
36       added to the "_ASNCIDR_" tag, separated by spaces, eg:
37
38        X-Spam-ASN: AS1680 89.138.0.0/15 89.139.0.0/16
39
40       Note that the literal "AS" before the ASN in the _ASN_ tag is
41       configurable through the asn_prefix directive and may be set to an
42       empty string.
43

CONFIGURATION

45       The standard ruleset contains a configuration that will add a header
46       field containing ASN data to scanned messages.  The bayes tokenizer
47       will use the added header field for bayes calculations, and thus affect
48       which BAYES_* rule will trigger for a particular message.
49
50       Note that in most cases you should not score on the ASN data directly.
51       Bayes learning will probably trigger on the _ASNCIDR_ tag, but probably
52       not very well on the _ASN_ tag alone.
53

STATUS

61       No in-depth analysis of the usefulness of bayes tokenization of ASN
62       data has been performed.
63

ADMINISTRATOR SETTINGS

65       asn_lookup asn-zone.example.com [ _ASNTAG_ _ASNCIDRTAG_ ]
66           Use this to lookup the ASN info in the specified zone for the first
67           external IP address and add the AS number to the first specified
68           tag and routing info to the second specified tag.
69
70           If no tags are specified the AS number will be added to the _ASN_
71           tag and the routing info will be added to the _ASNCIDR_ tag.  You
72           must specify either none or both of the tag names.  Tag names must
73           start and end with an underscore.
74
75           If two or more asn_lookups use the same set of template tags, the
76           results of their lookups will be appended to each other in the
77           template tag values in no particular order.  Duplicate results will
78           be omitted when combining results.  In a similar fashion, you can
79           also use the same template tag for both the AS number tag and the
80           routing info tag.
81
82           Examples:
83
84             asn_lookup asn.routeviews.org
85
86             asn_lookup asn.routeviews.org _ASN_ _ASNCIDR_
87             asn_lookup myview.example.com _MYASN_ _MYASNCIDR_
88
89             asn_lookup asn.routeviews.org _COMBINEDASN_ _COMBINEDASNCIDR_
90             asn_lookup myview.example.com _COMBINEDASN_ _COMBINEDASNCIDR_
91
92             asn_lookup in1tag.example.net _ASNDATA_ _ASNDATA_
93
94       clear_asn_lookups
95
96       Removes any previously declared asn_lookup entries from a list of
97       queries.
98
99       asn_prefix 'prefix_string'       (default: 'AS')
100           The string specified in the argument is prepended to each ASN when
101           storing it as a tag. This prefix is rather redundant, but its
102           default value 'AS' is kept for backward compatibility with versions
103           of SpamAssassin earlier than 3.4.0. A sensible setting is an empty
104           string. The argument may be (but need not be) enclosed in single or
105           double quotes for clarity.
106
107
108
109perl v5.16.3                      2014-02-07Mail::SpamAssassin::Plugin::ASN(3)