bramr/tor-exits

Retrieves tor exit list from the tor project and make that available in a convenient way.

v1.0.0 2016-11-21 22:58 UTC

Requires

• php: >=5.6.0
• guzzlehttp/guzzle: ~6.0
• psr/http-message: ~1.0
• psr/log: ~1.0

Requires (Dev)

• monolog/monolog: ^1.21
• php-mock/php-mock: ~1.0
• phpunit/phpunit: ~5.0

MIT

• Bram Rohde

README

A simple library to retreive a convenient list of current Tor exit nodes/relays.

Installation

The easiest way to install tor-exits is with Composer.

composer require bramr/tor-exits

Usage

$clientIp = '127.0.0.1';

//simplest example using tor project exit node list
$parser = new TorProjectParser(new TorProjectCollector());
$ipList = IpList::fromParserWithCache($parser, new IpListJsonCache());

if ($ipList->contains($clientIp)) {
    echo 'client uses Tor.';
}

There is a lot more to configure, for more complex examples see: example.php

Important

Please don't use this code to outright block users coming from the Tor network.
There are perfectly valid reasons to use Tor. (and better ways to block all Tor traffic to your site)

Also never refresh the list more than once an hour.
The consensus document is only updated hourly, so fetching an exit node list more often is pointless.

I don't use this code in production myself. I use most of it for a personal project.
If you're running into problems feel free to contact me. I don't mind helping out.

License

MIT, for details see LICENSE file.