diff --git a/README.md b/README.md index 194d6cb..13202a4 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,7 @@ Then run `composer update` ```php require_once 'joshtronic/ProjectHoneyPot.php'; -$php = new joshtronic\ProjectHoneyPot(); +$php = new joshtronic\ProjectHoneyPot('_YOUR_API_KEY_'); ``` ### Performing a Lookup @@ -44,8 +44,41 @@ print_r($results); Queries will return an array of information about the IP address. The array will contain `last_activity`, `threat_score` and an array of `categories`. +### Simulating Results + +The folks at Project Honey Pot were kind enough to include a way to simulate results from their http:BL API. You can do so by performing queries against the following IP addresses. + +#### Visitor Types + +* 127.1.1.0 - Search Engine +* 127.1.1.1 - Suspicious +* 127.1.1.2 - Harvester +* 127.1.1.3 - Suspicious & Harvester +* 127.1.1.4 - Comment Spammer +* 127.1.1.5 - Suspicious & Comment Spammer +* 127.1.1.6 - Harvester & Comment Spammer +* 127.1.1.7 - Suspicious & Harvester & Comment Spammer + +#### Threat Levels + +* 127.1.10.1 - Threat level 10 +* 127.1.20.1 - Threat level 20 +* 127.1.40.1 - Threat level 40 +* 127.1.80.1 - Threat level 80 + +#### Number of Days + +* 127.10.1.1 - 10 days since last seen +* 127.20.1.1 - 20 days since last seen +* 127.40.1.1 - 40 days since last seen +* 127.80.1.1 - 80 days since last seen + ## Contributing Suggestions and bug reports are always welcome, but karma points are earned for pull requests. Unit tests are required for all contributions. You can run the test suite from the `tests` directory simply by running `phpunit .` + +I also urge you to install a honey pot and donate some MX records to Project Honey Pot. They are doing great work, they provide http:BL as a free service and your donations help make their service ever better! + +If you’re not already a member, please sign up today with [my referral code](http://www.projecthoneypot.org?rf=123193). diff --git a/example.php b/example.php deleted file mode 100644 index c2e64b0..0000000 --- a/example.php +++ /dev/null @@ -1,41 +0,0 @@ -query('127.0.0.1')); - -// Simulate different types -/* -var_dump($php->query('127.1.1.0')); -var_dump($php->query('127.1.1.1')); -var_dump($php->query('127.1.1.2')); -var_dump($php->query('127.1.1.3')); -var_dump($php->query('127.1.1.4')); -var_dump($php->query('127.1.1.5')); -var_dump($php->query('127.1.1.6')); -var_dump($php->query('127.1.1.7')); -*/ - -// Simulate different threat levels -/* -var_dump($php->query('127.1.10.1')); -var_dump($php->query('127.1.20.1')); -var_dump($php->query('127.1.40.1')); -var_dump($php->query('127.1.80.1')); -*/ - -// Simulate different number of days -/* -var_dump($php->query('127.10.1.1')); -var_dump($php->query('127.20.1.1')); -var_dump($php->query('127.40.1.1')); -var_dump($php->query('127.80.1.1')); -*/ - -// Not a simulation, legit comment spammer -var_dump($php->query('60.169.75.161')); - -?>