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
16        header TEST_AS1234 X-ASN =~ /^1234$/
17

DESCRIPTION

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

TEMPLATE TAGS

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

CONFIGURATION

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

STATUS

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

ADMINISTRATOR SETTINGS

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