.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Mail::SpamAssassin::Plugin::URILocalBL 3pm"
.TH Mail::SpamAssassin::Plugin::URILocalBL 3pm "2021-03-26" "perl v5.28.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
URILocalBL \- blacklist URIs using local information (ISP names, address lists, and country codes)
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
This plugin creates some new rule test types, such as \*(L"uri_block_cc\*(R",
\&\*(L"uri_block_cidr\*(R", and \*(L"uri_block_isp\*(R".  These rules apply to the URIs
found in the \s-1HTML\s0 portion of a message, i.e. <a href=...> markup.
.PP
.Vb 1
\&  loadplugin    Mail::SpamAssassin::Plugin::URILocalBL
.Ve
.PP
Why local blacklisting? There are a few excellent, effective, and
well-maintained \s-1DNSBL\s0's out there. But they have several drawbacks:
.IP "\(bu" 2
blacklists can cover tens of thousands of entries, and you can't select which ones you use;
.IP "\(bu" 2
verifying that it's correctly configured can be non-trivial;
.IP "\(bu" 2
new blacklisting entries may take a while to be detected and entered, so it's not instantaneous.
.PP
Sometimes all you want is a quick, easy, and very surgical blacklisting of
a particular site or a particular \s-1ISP.\s0 This plugin is defined for that
exact usage case.
.SH "RULE DEFINITIONS AND PRIVILEGED SETTINGS"
.IX Header "RULE DEFINITIONS AND PRIVILEGED SETTINGS"
The format for defining a rule is as follows:
.PP
.Vb 1
\&  uri_block_cc SYMBOLIC_TEST_NAME cc1 cc2 cc3 cc4
.Ve
.PP
or:
.PP
.Vb 1
\&  uri_block_cont SYMBOLIC_TEST_NAME co1 co2 co3 co4
.Ve
.PP
or:
.PP
.Vb 1
\&  uri_block_cidr SYMBOLIC_TEST_NAME a.a.a.a b.b.b.b/cc d.d.d.d\-e.e.e.e
.Ve
.PP
or:
.PP
.Vb 1
\&  uri_block_isp SYMBOLIC_TEST_NAME "DataRancid" "McCarrier" "Phishers\-r\-Us"
.Ve
.PP
Example rule for matching a \s-1URI\s0 in China:
.PP
.Vb 1
\&  uri_block_cc TEST1 cn
.Ve
.PP
This would block the \s-1URL\s0 http://www.baidu.com/index.htm.  Similarly, to
match a Spam-haven netblock:
.PP
.Vb 1
\&  uri_block_cidr TEST2 65.181.64.0/18
.Ve
.PP
would match a netblock where several phishing sites were recently hosted.
.PP
And to block all \s-1CIDR\s0 blocks registered to an \s-1ISP,\s0 one might use:
.PP
.Vb 1
\&  uri_block_isp TEST3 "ColoCrossing"
.Ve
.PP
if one didn't trust \s-1URL\s0's pointing to that organization's clients.  Lastly,
if there's a country that you want to block but there's an explicit host
you wish to exempt from that blacklist, you can use:
.PP
.Vb 1
\&  uri_block_exclude TEST1 www.baidu.com
.Ve
.PP
if you wish to exempt \s-1URL\s0's referring to this host. The same syntax is
applicable to \s-1CIDR\s0 and \s-1ISP\s0 blocks as well.
.SH "DEPENDENCIES"
.IX Header "DEPENDENCIES"
The Country-Code based filtering requires the Geo::IP or GeoIP2 module, 
which uses either the fremium GeoLiteCountry database, or the commercial 
version of it called GeoIP from MaxMind.com.
.PP
The \s-1ISP\s0 based filtering requires the same module, plus the GeoIPISP database.
There is no fremium version of this database, so commercial licensing is
required.
.IP "uri_country_db_path \s-1STRING\s0" 2
.IX Item "uri_country_db_path STRING"
This option tells SpamAssassin where to find the MaxMind country GeoIP2 
database.
.IP "uri_country_db_isp_path \s-1STRING\s0" 2
.IX Item "uri_country_db_isp_path STRING"
This option tells SpamAssassin where to find the MaxMind isp GeoIP2 database.