.\" -*- 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::MtPolicyd::Plugin::SqlList 3pm"
.TH Mail::MtPolicyd::Plugin::SqlList 3pm 2024-05-26 "perl v5.38.2" "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.05
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 5
\&  <Plugin whitelist>
\&    module="SqlList"
\&    sql_query="SELECT client_ip FROM whitelist WHERE client_ip=?"
\&    match_action=dunno
\&  </Plugin>
\&
\&  <Plugin blacklist>
\&    module="SqlList"
\&    sql_query="SELECT client_ip FROM blacklist WHERE client_ip=?"
\&    match_action="reject you are blacklisted!"
\&  </Plugin>
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Plugin checks a field against a SQL table/query.
.PP
Depending on whether a supplied SQL query matched actions can be taken.
.SS PARAMETERS
.IX Subsection "PARAMETERS"
The module takes the following parameters:
.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.
.IP "sql_query (default: ""SELECT client_ip FROM whitelist WHERE client_ip=INET_ATON(?)"")" 4
.IX Item "sql_query (default: ""SELECT client_ip FROM whitelist WHERE client_ip=INET_ATON(?)"")"
Prepared SQL statement to use for checking an IP address.
.Sp
? will be replaced by the IP 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 MTA if the SQL 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 MTA if the SQL query DID NOT matched.
.IP "score (default: empty)" 4
.IX Item "score (default: empty)"
If given this score will be applied to the session.
.IP "field (default: client_address)" 4
.IX Item "field (default: client_address)"
The field the query parameter will be taken from.
.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
\&  <VirtualHost 12345>
\&    name="reputation"
\&    <Plugin whitelist>
\&      module="SqlList"
\&      sql_query="SELECT client_ip FROM whitelist WHERE client_ip=INET_ATON(?)"
\&      match_action="dunno"
\&    </Plugin>
\&    <Plugin trigger\-greylisting>
\&    ...
\&  </VirtualHost>
.Ve
.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