.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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::Phishing 3"
.TH Mail::SpamAssassin::Plugin::Phishing 3 2023-07-26 "perl v5.38.0" "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
Mail::SpamAssassin::Plugin::Phishing \- check uris against phishing feed
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  loadplugin Mail::SpamAssassin::Plugin::Phishing
\&
\&  ifplugin Mail::SpamAssassin::Plugin::Phishing
\&    phishing_openphish_feed /etc/mail/spamassassin/openphish\-feed.txt
\&    phishing_phishtank_feed /etc/mail/spamassassin/phishtank\-feed.csv
\&    phishing_phishstats_feed /etc/mail/spamassassin/phishstats\-feed.csv
\&    body     URI_PHISHING      eval:check_phishing()
\&    describe URI_PHISHING      Url match phishing in feed
\&  endif
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This plugin finds uris used in phishing campaigns detected by
OpenPhish, PhishTank or PhishStats feeds.
.PP
The Openphish free feed is updated every 6 hours and can be downloaded from
https://openphish.com/feed.txt.
.PP
The PhishTank free feed is updated every 1 hours and can be downloaded from
http://data.phishtank.com/data/online\-valid.csv.
To avoid download limits a registration is required.
.PP
The PhishStats feed is updated every 90 minutes and can be downloaded from
https://phishstats.info/phish_score.csv.
.SH "ADMIN PREFERENCES"
.IX Header "ADMIN PREFERENCES"
The following options can be used in site-wide (\f(CW\*(C`local.cf\*(C'\fR)
configuration files to customize how the module handles phishing uris
.IP phishing_openphish_feed 4
.IX Item "phishing_openphish_feed"
Absolute path of the downloaded OpenPhish datafeed.
.IP phishing_phishtank_feed 4
.IX Item "phishing_phishtank_feed"
Absolute path of the downloaded PhishTank datafeed.
.IP "phishing_uri_noparam ( 0 | 1 ) (default: 0)" 4
.IX Item "phishing_uri_noparam ( 0 | 1 ) (default: 0)"
If this option is set uri parameters will not be take into consideration
when parsing the phishing uris datafeed.
If this option is enabled and the url without parameters is "generic"
(like https://www.kisa.link/url_redirector.php?url=...) the url will be
skipped.
.IP phishing_phishstats_feed 4
.IX Item "phishing_phishstats_feed"
Absolute path of the downloaded PhishStats datafeed.
.IP "phishing_phishstats_minscore ( 0 \- 10 ) (default: 6)" 4
.IX Item "phishing_phishstats_minscore ( 0 - 10 ) (default: 6)"
Minimum score to take into consideration for phishing uris downloaded
from PhishStats datafeed.