$Revision: 1.2 $
$Date: 2004/08/24 09:00:35 $
User's Guide
Overview
The module keeps trace of all (or selected ones) incoming request's &ip; source
and blocks the ones that exceeded some limit. Works simultaneous for IPv4 and
IPv6 addresses.
Dependencies
&ser; Modules
The following modules must be loaded before this module:
No dependencies on other &ser; modules.
External Libraries or Applications
The following libraries or applications must be installed before running
&ser; with this module loaded:
None.
Exported Parameters
<varname>sampling_time_unit</varname> (integer)
Time period used for sampling (or the sampling accuracy ;-) ). The smaller the
better, but slower. If you want to detect peeks, use a small one. To limit the
access (like total number of requests on a long period of time) to a proxy resource
(a gateway for ex), use a bigger value of this parameter.
Default value is 2.
Set <varname>sampling_time_unit</varname> parameter
...
modparam("pike", "sampling_time_unit", 10)
...
<varname>reqs_density_per_unit</varname> (integer)
How many requests should be allowed per sampling_time_unit before blocking all the
incoming request from that &ip;. Practically, the blocking limit is between ( let's
have x=reqs_density_per_unit) x and 3*x for IPv4 addresses and between x and 8*x for
ipv6 addresses.
Default value is 30.
Set <varname>reqs_density_per_unit</varname> parameter
...
modparam("pike", "reqs_density_per_unit", 30)
...
<varname>remove_latency</varname> (integer)
For how long the &ip; address will be kept in memory after the last request from
that &ip; address. It's a sort of timeout value.
Default value is 120.
Set <varname>remove_latency</varname> parameter
...
modparam("pike", "remove_latency", 130)
...
Exported Functions
<function moreinfo="none">pike_check_req()</function>
Process the source &ip; of the current request and returns false if the &ip; was
exceeded the blocking limit.
Meaning of the parameters is as follows:
<function>pike_check_req</function> usage
...
if (!pike_check_req()) { break; };
...