pike Module

The following modules must be loaded before this module:

The following libraries or applications must be installed before running OpenSIPS with this module loaded:

Time period used for sampling (or the sampling accuracy ;-) ). The smaller the better, but slower. If you want to detect peaks, 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.

IMPORTANT: a too small value may lead to performance penalties due timer process overloading.

Default value is 2.

...
modparam("pike", "sampling_time_unit", 10)
...

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.

...
modparam("pike", "reqs_density_per_unit", 30)
...

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.

Note: If the remove_latency value is lower than sampling_time_unit value, nodes might expire before being unblocked, therefore losing some UNBLOCK events. In order to prevent this, if the remove_latency is lower, OpenSIPS internally forces its value to sampling_time_unit + 1.

Default value is 120.

...
modparam("pike", "remove_latency", 130)
...

The name of the script route to be triggers (in automatic way) when a package is received from the network. If you do a "drop" in this route, it will indicate to the module that the source IP of the package does not need to be monitored. Otherwise, the source IP will be automatically monitered.

By defining this parameter, the automatic checking mode is enabled.

Default value is NONE (no auto mode).

...
modparam("pike", "check_route", "pike")
...
route[pike]{
    if ($si==111.222.111.222)  /*trusted, do not check it*/
        drop;
    /* all other IPs are checked*/
}
....

Log level to be used by module to auto report the blocking (only first time) and unblocking of IPs detected as source of floods.

Default value is 1 (L_WARN).

...
modparam("pike", "pike_log_level", -1)
...

Process the source IP of the current request and returns false if the IP was exceeding the blocking limit.

Return codes:

This function can be used from REQUEST_ROUTE.

...
if (!pike_check_req()) { exit; };
...

Lists the nodes in the pike tree.

Name: pike_list

Parameters: none

MI FIFO Command Format:

		opensips-cli -x mi pike_list
		

Remove a node from the pike tree by IP address.

Name: pike_rm

Parameters:

MI FIFO Command Format:

		opensips-cli -x mi pike_rm 10.0.0.106
		

This event is raised when the pike module decides that an IP should be blocked.

Parameters: