.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32)
.\"
.\" 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
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "Mail::MtPolicyd::Plugin::Honeypot 3pm"
.TH Mail::MtPolicyd::Plugin::Honeypot 3pm "2017-01-13" "perl v5.24.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"
Mail::MtPolicyd::Plugin::Honeypot \- mtpolicyd plugin for creating an honeypot
.SH "VERSION"
.IX Header "VERSION"
version 2.02
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The Honeypot plugin creates an honeypot to trap IPs sending to unused recipient addresses.
.PP
The plugin requires that you define unused recipient addresses as honeypots.
These addresses can be specified by the recipients and recipients_re parameters.
.PP
Each time an \s-1IP\s0 tries to send an mail to one of these honeypots the message will be
reject if mode is 'reject' and an scoring is applied.
The \s-1IP\s0 is also added to a temporary \s-1IP\s0 blacklist till an timeout is reached (parameter expire).
All IPs on this blacklist will also be rejected if mode is 'reject' and scoring is applied.
.SH "EXAMPLE"
.IX Header "EXAMPLE"
.Vb 5
\&  <Plugin honeypot>
\&    module = "Honeypot"
\&    recipients = "bob@company.com,joe@company.com"
\&    recipients_re = "^(tic|tric|trac)@(gmail|googlemail)\e.de$"
\&  </Plugin>
.Ve
.SH "PARAMETERS"
.IX Header "PARAMETERS"
.IP "(uc_)enabled (default: on)" 4
.IX Item "(uc_)enabled (default: on)"
Enable/disable this check.
.IP "score (default: empty)" 4
.IX Item "score (default: empty)"
Apply an score to this message if it is send to an honeypot address or it has been
added to the honeypot before by sending an mail to an honeypot.
.IP "mode (default: reject)" 4
.IX Item "mode (default: reject)"
The default is to return an reject.
.Sp
Change to 'passive' if you just want scoring.
.IP "recipients (default: '')" 4
.IX Item "recipients (default: '')"
A comma separated list of recipients to use as honeypots.
.IP "recipients_re (default: '')" 4
.IX Item "recipients_re (default: '')"
A comma separated list of regular expression to match against the
recipient to use them as honeypots.
.IP "reject_message (default: 'trapped by honeypod')" 4
.IX Item "reject_message (default: 'trapped by honeypod')"
A string to return with the reject action.
.IP "expire (default: 7200 (2h))" 4
.IX Item "expire (default: 7200 (2h))"
Time in seconds till the client_ip is removed from the honeypot.
.IP "Plugin (default: empty)" 4
.IX Item "Plugin (default: empty)"
Execute this plugins when the condition matched.
.SH "AUTHOR"
.IX Header "AUTHOR"
Markus Benning <ich@markusbenning.de>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is Copyright (c) 2014 by Markus Benning <ich@markusbenning.de>.
.PP
This is free software, licensed under:
.PP
.Vb 1
\&  The GNU General Public License, Version 2, June 1991
.Ve