Coercive Security BotKicker

A simple detection based on black list, _(*1)

Get

composer require coercive/botkicker

List infos

PERISHABLE PRESS ULTIMATE USER-AGENT BLACKLIST https://perishablepress.com/4g-ultimate-user-agent-blacklist/, _(*2)
PERISHABLE PRESS ULTIMATE REFERRER BLACKLIST https://perishablepress.com/4g-ultimate-referrer-blacklist/, _(*3)
CHONGQED REFERER BLACKLIST http://blacklist.chongqed.org/, _(*4)
MITCHELL KROG - BlackList file from apache set https://github.com/mitchellkrogza, _(*5)

Warning info

Some terms where placed in ambiguous list because of too large detection. You can find this ambiguous file are in each list directory. (work in progress), _(*6)

Kicker system

Basics, _(*7)

use  Coercive\Security\BotKicker\UserAgentKicker;

# Get Instance
$kicker = new UserAgentKicker; // or othe kicker

# Load a default list
$kicker->loadCoerciveLists();
# or load custom list...

# Basic bot detection
if(!$kicker->detect()->getStatus()) {
    echo 'a bot is detected';
}
else {
    # True if in whitelist or not in blacklist
}

You can detect if UA need the robots.txt, _(*8)

if($kicker->isRobotsTxtRequested()) { /* do something */ }

(Dis)Allow empty

# You can (dis)allow empty current detection
$kicker->allowEmpty( true | false );

HostKicker only

You can detect host name from an ip list, _(*9)

# HostKicker only
$kicker = new HostKicker;

# Set your ip list
$kicker->setHostFromIp( [
    'xxx.xx.xx.x',
    'yy.yyy.y.y',
    '...',
] );

IpKicker only

You can use the auto IP detection from IpKicker, _(*10)

# Get auto Ip list detection
$list = (new IpKicker)->getCurrents();

# Set auto ip list
$kicker = new HostKicker;
$kicker->setHostFromIp($list);

IpKicker can now detect Facebookbot and Bingbot, _(*11)

# Get auto Ip list detection
$ipk = new IpKicker;

$list = $ipk->getFacebookList();

$list = $ipk->isBing('157.55.39.1', true | false); # Linux Host cmd (true) / NsLookUp (false)

Trigger on custom element

# Example of custom datas
$datas = ['bot1', 'bot2', 'bot3'];

# Override auto detection
$kicker->setCurrents($datas);

# Show detection result
$status = $kicker->detect();
var_dump( $status->getList() );

Handle custom list

You can set your own list (array format), _(*12)

$kicker->setBlackList([
    'bad',
    'bad too'
]);
$kicker->setWhiteList([
    'good',
    'good too'
]);

Or from file (txt brut format), _(*13)

$kicker->setBlackListFromFiles([
    '/path/file1',
    '/path/file2'
]);
$kicker->setWhiteListFromFiles([
    '/path/file1',
    '/path/file2'
]);

If some list are already loaded, you can add some items like that, _(*14)

$kicker->addToBlackList([
    'bad',
    'bad too'
]);
$kicker->addToWhiteList([
    'good',
    'good too'
]);

Handle custom elements to verify

# Example of custom datas
$datas = ['bot1', 'bot2', 'bot3'];

# Override auto detection
$kicker->setCurrents($datas);

# Show detection result
$status = $kicker->detect();

var_dump( $status->getStatus() ); # bool if ok or not
var_dump( $status->getList() ); # array list of match elements
var_dump( $status->getCurrents() ); # array current datas

Host / Ns Look Up

Get the domains list from IP, _(*15)

use Coercive\Security\BotKicker\HostLookUp;
use Coercive\Security\BotKicker\NsLookUp;

$look = new HostLookUp;
# OR
$look = new NsLookUp;

$array = $look->getDomains('111.22.33.4');

Get the ip list from domain, _(*16)

use Coercive\Security\BotKicker\HostLookUp;
use Coercive\Security\BotKicker\NsLookUp;

$look = new HostLookUp;
# OR
$look = new NsLookUp;

$array = $look->getIps('www.example.com.');

Match item, _(*17)

use Coercive\Security\BotKicker\HostLookUp;
use Coercive\Security\BotKicker\NsLookUp;

$look = new HostLookUp;
# OR
$look = new NsLookUp;

# Match ip > domain
$array = $look->match('111.22.33.4', 'www.example.com.');

# OR mactch with reverse (match ip > domain first and domain > ip after)
$array = $look->match('111.22.33.4', 'www.example.com.', true);