Extension:IPInfoFilter


MediaWiki extensions manual
IPInfoFilter
Release status: beta
Implementation
Description Enhances abuse filtering by utilizing information obtained from IP addresses in conjunction with AbuseFilter.
Author(s) (Harugon1talk)
MediaWiki 1.39
PHP 7.4+
License No license specified
Download
README
Parameters
  • $wgIPInfoFilterGeoLite2AsnPath
  • $wgIPInfoFilterGeoLite2CountryPath
  • $wgIPInfoFilterProxyCheckIoKey
Hooks used
  • AbuseFilter-builder
  • AbuseFilter-generateUserVars
  • AbuseFilter-computeVariable

The IPInfoFilter extension integrates with AbuseFilter to enhance abuse filtering by utilizing information obtained from IP addresses.

Installation

  • Download and place the file(s) in a directory called IPInfoFilter in your extensions/ folder.
  • Only when installing from Git, run Composer to install PHP dependencies, by issuing composer install --no-dev in the extension directory. (See task T173141 for potential complications.)
  • Add the following code at the bottom of your LocalSettings.php file:
    wfLoadExtension( 'IPInfoFilter' );
    $wgIPInfoFilterGeoLite2CountryPath = "/path/to/GeoLite2-Country.mmdb";
    $wgIPInfoFilterGeoLite2ASNPath = "/path/to/GeoLite2-ASN.mmdb";
    
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Configuration parameters

$wgIPInfoFilterGeoLite2AsnPath
Path to the GeoLite2 ASN database file.
$wgIPInfoFilterGeoLite2CountryPath
Path to the GeoLite2 Country database file.
$wgIPInfoFilterProxyCheckIoKey
API key for accessing the ProxyCheck.io service.

If both GeoLite2 and ProxyCheck.io configurations are set up, GeoLite2 will take precedence.

Usage

Variables

Description Name Data type Notes
Country code based on IP address following ISO 3166-1 ipinfo_country String (Provided by GeoLite2, Proxycheck.io)
AS number (ASN) of the IP address ipinfo_asn Integer (Provided by GeoLite2, Proxycheck.io)
Risk score of the IP address (from 0 to 100) ipinfo_risk Integer (Provided by Proxycheck.io)
Whether the IP address is a proxy (true/false) ipinfo_proxy Boolean (Provided by Proxycheck.io)

The available variables are limited depending on the data source.

See also