.\" 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::SqlList 3pm"
.TH Mail::MtPolicyd::Plugin::SqlList 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::SqlList \- mtpolicyd plugin for accessing a SQL white/black/access list
.SH "VERSION"
.IX Header "VERSION"
version 2.02
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 5
\&
\& module="SqlList"
\& sql_query="SELECT client_ip FROM whitelist WHERE client_ip=?"
\& match_action=dunno
\&
\&
\&
\& module="SqlList"
\& sql_query="SELECT client_ip FROM blacklist WHERE client_ip=?"
\& match_action="reject you are blacklisted!"
\&
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Plugin checks the client_address against a \s-1SQL\s0 table.
.PP
Depending on wether a supplied \s-1SQL\s0 query matched actions can be taken.
.SS "\s-1PARAMETERS\s0"
.IX Subsection "PARAMETERS"
The module takes the following parameters:
.ie n .IP "(uc_)enabled (default: ""on"")" 4
.el .IP "(uc_)enabled (default: ``on'')" 4
.IX Item "(uc_)enabled (default: on)"
Could be set to 'off' to deactivate check. Could be used to activate/deactivate check per user.
.ie n .IP "sql_query (default: ""\s-1SELECT\s0 client_ip \s-1FROM\s0 whitelist \s-1WHERE\s0 client_ip=INET_ATON(?)"")" 4
.el .IP "sql_query (default: ``\s-1SELECT\s0 client_ip \s-1FROM\s0 whitelist \s-1WHERE\s0 client_ip=INET_ATON(?)'')" 4
.IX Item "sql_query (default: SELECT client_ip FROM whitelist WHERE client_ip=INET_ATON(?))"
Prepared \s-1SQL\s0 statement to use for checking an \s-1IP\s0 address.
.Sp
? will be replaced by the \s-1IP\s0 address.
.Sp
The module will match if the statement returns one or more rows.
.PP
By default the plugin will do nothing. One of the following actions should be specified:
.IP "match_action (default: empty)" 4
.IX Item "match_action (default: empty)"
If given this action will be returned to the \s-1MTA\s0 if the \s-1SQL\s0 query matched.
.IP "not_match_action (default: empty)" 4
.IX Item "not_match_action (default: empty)"
If given this action will be returned to the \s-1MTA\s0 if the \s-1SQL\s0 query \s-1DID NOT\s0 matched.
.IP "score (default: empty)" 4
.IX Item "score (default: empty)"
If given this score will be applied to the session.
.SH "EXAMPLE WITH A MYSQL TABLE"
.IX Header "EXAMPLE WITH A MYSQL TABLE"
You may use the following table for storing ipv4 addresses in MySQL:
.PP
.Vb 6
\& CREATE TABLE \`whitelist\` (
\& \`id\` int(11) NOT NULL AUTO_INCREMENT,
\& \`client_ip\` INT UNSIGNED NOT NULL,
\& PRIMARY KEY (\`id\`),
\& UNIQUE KEY \`client_ip\` (\`client_ip\`)
\& ) ENGINE=MyISAM DEFAULT CHARSET=latin1
\&
\& INSERT INTO whitelist VALUES(NULL, INET_ATON(\*(Aq127.0.0.1\*(Aq));
.Ve
.PP
And use it as a whitelist in mtpolicyd:
.PP
.Vb 10
\&
\& name="reputation"
\&
\& module="SqlList"
\& sql_query="SELECT client_ip FROM whitelist WHERE client_ip=INET_ATON(?)"
\& match_action="dunno"
\&
\&
\& ...
\&
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
Markus Benning
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is Copyright (c) 2014 by Markus Benning .
.PP
This is free software, licensed under:
.PP
.Vb 1
\& The GNU General Public License, Version 2, June 1991
.Ve