From 8c55d0b0cb84cacd7462519069e562e85e5a5cf7 Mon Sep 17 00:00:00 2001 From: Markus Makela Date: Sun, 19 Oct 2014 07:05:45 +0300 Subject: [PATCH] Added documentation about rule syntax. --- server/modules/filter/fwfilter.c | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/server/modules/filter/fwfilter.c b/server/modules/filter/fwfilter.c index aa373b8e1..b45ee97de 100644 --- a/server/modules/filter/fwfilter.c +++ b/server/modules/filter/fwfilter.c @@ -21,6 +21,18 @@ * Firewall Filter * * A filter that acts as a firewall, blocking queries that do not meet the set requirements. + * + * This filter uses "rules" to define the blcking parameters. To configure rules into the configuration file, + * give each rule a unique name and assing the rule contents by passing a string enclosed in quotes. + * + * For example, to block users John and Jane and all users from address range 192.168.0.0/24, the following is needed in the configuration file: + * rule1="block users John Jane" + * rule2="block 192.168.0.0/255.255.255.0" + * + * Rule syntax + * + * [block|allow] [users|columns|times] value ... Blocks or allows the given list of values interpreted as certain type + * require where [all|select|update|insert|delete] ... Requires a where clause for the list of query types */ #include #include