Compare commits

..

No commits in common. "master" and "v0.9.9" have entirely different histories.

10 changed files with 136 additions and 186 deletions

2
.gitignore vendored
View file

@ -1 +1,3 @@
_*
.old*
vendor/*

View file

@ -1,6 +1,6 @@
MIT License
Copyright (c) 2020-2022 kristuff
Copyright (c) 2020-2021 kristuff
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal

View file

@ -16,8 +16,7 @@ Features
- Single IP report request **✓**
- Bulk report request (send `csv` file) **✓**
- Clear IP address request (remove your own reports) **✓**
- Auto cleaning report comments from sensitive data (email, custom ip/domain names list) **✓**
- Define timeout for cURL internal requests **✓**
- Auto cleaning report comments from sensitive data (email, custom ip/domain names list) **✓**
Requirements
------------
@ -33,7 +32,7 @@ Deploy with composer:
```json
...
"require": {
"kristuff/abuseipdb": "^1.1-stable"
"kristuff/abuseipdb": ">=0.9.9-stable"
},
```
@ -42,7 +41,8 @@ More infos
- [Project website](https://kristuff.fr/projects/abuseipdb)
- [Api documentation](https://kristuff.fr/projects/abuseipdb/doc)
- CLI version: [github](https://github.com/kristuff/abuseipdb-cli) | [website](https://kristuff.fr/projects/abuseipdbcli)
- [Config/Install guide](https://kristuff.fr/projects/abuseipdb/technical#configuration)
- [CLI version](https://kristuff.fr/projects/abuseipdbcli)
License
@ -50,7 +50,7 @@ License
The MIT License (MIT)
Copyright (c) 2020-2022 Kristuff
Copyright (c) 2020-2021 Kristuff
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal

View file

@ -2,14 +2,11 @@
"name": "kristuff/abuseipdb",
"description": "A PHP wrapper for AbuseIPDB API v2",
"type": "library",
"keywords": ["abuseIPDB", "API"],
"license": "MIT",
"authors": [
{
"name": "Kristuff",
"homepage": "https://github.com/kristuff",
"email": "kristuff@kristuff.fr",
"role": "Developer"
"homepage": "https://github.com/kristuff"
}
],
"require": {

View file

@ -1,20 +1,21 @@
<?php declare(strict_types=1);
/**
* _ ___ ___ ___ ___
* __ _| |__ _ _ ___ ___|_ _| _ \ \| _ )
* / _` | '_ \ || (_-</ -_)| || _/ |) | _ \
* \__,_|_.__/\_,_/__/\___|___|_| |___/|___/
* _ _ ___ ____ ____ ____
* / \ | |__ _ _ ___ ___|_ _| _ \| _ \| __ )
* / _ \ | '_ \| | | / __|/ _ \| || |_) | | | | _ \
* / ___ \| |_) | |_| \__ \ __/| || __/| |_| | |_) |
* /_/ \_\_.__/ \__,_|___/\___|___|_| |____/|____/
*
* This file is part of Kristuff\AbuseIPDB.
* This file is part of Kristuff\AbsuseIPDB.
*
* (c) Kristuff <kristuff@kristuff.fr>
* (c) Kristuff <contact@kristuff.fr>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*
* @version 1.1
* @copyright 2020-2022 Kristuff
* @version 0.9.9
* @copyright 2020-2021 Kristuff
*/
namespace Kristuff\AbuseIPDB;
@ -43,13 +44,12 @@ abstract class ApiBase
/**
* AbuseIPDB API v2 categories
* shortname, id (string), long name
* last parameter is false when the category can't be used alone
* shorname, id (string), long name
* last paramter is false when the category cant' be used alone
*
* @static
* @var array
*/
protected static $aipdbApiCategories = [
protected $aipdbApiCategories = [
// Altering DNS records resulting in improper redirection.
['dns-c' , '1', 'DNS Compromise', true],
@ -127,36 +127,34 @@ abstract class ApiBase
// Abuse was targeted at an "Internet of Things" type device. Include
// information about what type of device was targeted in the comments.
['iot' , '23', 'IoT Targeted', true],
['oit' , '23', 'IoT Targeted', true],
];
/**
* Get the list of report categories
*
* @access public
* @static
*
* @return array
*/
public static function getCategories(): array
public function getCategories()
{
return self::$aipdbApiCategories;
return $this->aipdbApiCategories;
}
/**
* Get the category id corresponding to given name
*
* @access public
* @static
* @param string $categoryName The report category name
* @param string $categoryName The report categoriy name
*
* @return string|bool The category id in string format if found, otherwise false
*/
public static function getCategoryIdByName(string $categoryName)
public function getCategoryIdbyName(string $categoryName)
{
foreach (self::$aipdbApiCategories as $cat){
foreach ($this->aipdbApiCategories as $cat){
if ($cat[0] === $categoryName) {
return $cat[1];
return $cat;
}
}
@ -168,16 +166,15 @@ abstract class ApiBase
* Get the category name corresponding to given id
*
* @access public
* @static
* @param string $categoryId The report category id
*
* @return string|bool The category name if found, otherwise false
*/
public static function getCategoryNameById(string $categoryId)
public function getCategoryNameById(string $categoryId)
{
foreach (self::$aipdbApiCategories as $cat){
foreach ($this->aipdbApiCategories as $cat){
if ($cat[1] === $categoryId) {
return $cat[0];
return $cat;
}
}
@ -189,16 +186,15 @@ abstract class ApiBase
* Get the index of category corresponding to given value
*
* @access protected
* @static
* @param string $value The report category id or name
* @param string $index The index in value array
*
* @return int|bool The category index if found, otherwise false
*/
protected static function getCategoryIndex(string $value, int $index)
protected function getCategoryIndex(string $value, int $index)
{
$i = 0;
foreach (self::$aipdbApiCategories as $cat){
foreach ($this->aipdbApiCategories as $cat){
if ($cat[$index] === $value) {
return $i;
}
@ -233,7 +229,7 @@ abstract class ApiBase
foreach ($cats as $cat) {
// get index on our array of categories
$catIndex = is_numeric($cat) ? self::getCategoryIndex($cat, 1) : self::getCategoryIndex($cat, 0);
$catIndex = is_numeric($cat) ? $this->getCategoryIndex($cat, 1) : $this->getCategoryIndex($cat, 0);
// check if found
if ($catIndex === false ){
@ -241,13 +237,13 @@ abstract class ApiBase
}
// get Id
$catId = self::$aipdbApiCategories[$catIndex][1];
$catId = $this->aipdbApiCategories[$catIndex][1];
// need another ?
if ($needAnother !== false){
// is a standalone cat ?
if (self::$aipdbApiCategories[$catIndex][3] === false) {
if ($this->aipdbApiCategories[$catIndex][3] === false) {
$needAnother = true;
} else {

View file

@ -1,20 +1,21 @@
<?php declare(strict_types=1);
/**
* _ ___ ___ ___ ___
* __ _| |__ _ _ ___ ___|_ _| _ \ \| _ )
* / _` | '_ \ || (_-</ -_)| || _/ |) | _ \
* \__,_|_.__/\_,_/__/\___|___|_| |___/|___/
* _ _ ___ ____ ____ ____
* / \ | |__ _ _ ___ ___|_ _| _ \| _ \| __ )
* / _ \ | '_ \| | | / __|/ _ \| || |_) | | | | _ \
* / ___ \| |_) | |_| \__ \ __/| || __/| |_| | |_) |
* /_/ \_\_.__/ \__,_|___/\___|___|_| |____/|____/
*
* This file is part of Kristuff\AbuseIPDB.
* This file is part of Kristuff\AbsuseIPDB.
*
* (c) Kristuff <kristuff@kristuff.fr>
* (c) Kristuff <contact@kristuff.fr>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*
* @version 1.1
* @copyright 2020-2022 Kristuff
* @version 0.9.9
* @copyright 2020-2021 Kristuff
*/
namespace Kristuff\AbuseIPDB;
@ -32,9 +33,9 @@ class ApiHandler extends ApiBase
use CurlTrait;
/**
* @var string
* @var string $version
*/
const VERSION = 'v1.1';
const VERSION = 'v0.9.9';
/**
* The ips to remove from report messages
@ -45,46 +46,18 @@ class ApiHandler extends ApiBase
*/
protected $selfIps = [];
/**
* The maximum number of milliseconds to allow cURL functions to execute. If libcurl is
* built to use the standard system name resolver, that portion of the connect will still
* use full-second resolution for timeouts with a minimum timeout allowed of one second.
*
* @access protected
* @var int
*/
protected $timeout = 0;
/**
* Constructor
*
* @access public
* @param string $apiKey The AbuseIPDB api key
* @param array $myIps The Ips/domain name you don't want to display in report messages
* @param int $timeout The maximum number of milliseconds to allow internal cURL functions
* to execute. Default is 0, no timeout
*
*/
public function __construct(string $apiKey, array $myIps = [], int $timeout = 0)
public function __construct(string $apiKey, array $myIps = [])
{
$this->aipdbApiKey = $apiKey;
$this->selfIps = $myIps;
$this->timeout = $timeout;
}
/**
* Sets the cURL timeout (apply then to any API request). Overwrites the value passed in
* constructor, useful when performing multiple queries with same handler but different timeout.
*
* @access public
* @param int $timeout The maximum number of milliseconds to allow internal cURL functions
* to execute.
*
* @return void
*/
public function setTimeout(int $timeout): void
{
$this->timeout = $timeout;
}
/**
@ -99,7 +72,6 @@ class ApiHandler extends ApiBase
return array(
'apiKey' => $this->aipdbApiKey,
'selfIps' => $this->selfIps,
'timeout' => $this->timeout,
);
}
@ -188,7 +160,6 @@ class ApiHandler extends ApiBase
* @return ApiResponse
* @throws \RuntimeException
* @throws \InvalidArgumentException
* @throws InvalidPermissionException
*/
public function bulkReport(string $filePath): ApiResponse
{
@ -343,7 +314,7 @@ class ApiHandler extends ApiBase
* @param bool $plainText True to get the response in plaintext list. Default is false
* @param int $confidenceMinimum The abuse confidence score minimum (subscribers feature). Default is 100.
* The confidence minimum must be between 25 and 100.
* This parameter is a subscriber feature (not honored otherwise).
* This parameter is subscriber feature (not honored otherwise).
*
* @return ApiResponse
* @throws \RuntimeException
@ -385,9 +356,8 @@ class ApiHandler extends ApiBase
*/
protected function apiRequest(string $path, array $data, string $method = 'GET', string $csvFilePath = ''): ApiResponse
{
$curlErrorNumber = -1; // will be used later to check curl execution
$curlErrorMessage = '';
$url = $this->aipdbApiEndpoint . $path; // api url
// set api url
$url = $this->aipdbApiEndpoint . $path;
// set the wanted format, JSON (required to prevent having full html page on error)
// and the AbuseIPDB API Key as a header
@ -416,35 +386,17 @@ class ApiHandler extends ApiBase
$url .= '?' . http_build_query($data);
}
// set url and options
// set the url to call
$this->setCurlOption($ch, CURLOPT_URL, $url);
$this->setCurlOption($ch, CURLOPT_RETURNTRANSFER, 1);
$this->setCurlOption($ch, CURLOPT_HTTPHEADER, $headers);
/**
* set timeout
*
* @see https://curl.se/libcurl/c/CURLOPT_TIMEOUT_MS.html
* @see https://curl.se/libcurl/c/CURLOPT_CONNECTTIMEOUT_MS.html
* If libcurl is built to use the standard system name resolver, that portion of the transfer
* will still use full-second resolution for timeouts with a minimum timeout allowed of one second.
* In unix-like systems, this might cause signals to be used unless CURLOPT_NOSIGNAL is set.
*/
$this->setCurlOption($ch, CURLOPT_NOSIGNAL, 1);
$this->setCurlOption($ch, CURLOPT_TIMEOUT_MS, $this->timeout);
// execute curl call
$result = curl_exec($ch);
$curlErrorNumber = curl_errno($ch);
$curlErrorMessage = curl_error($ch);
// close connection
curl_close($ch);
if ($curlErrorNumber !== 0){
throw new \RuntimeException($curlErrorMessage);
}
return new ApiResponse($result !== false ? $result : '');
}
@ -469,8 +421,8 @@ class ApiHandler extends ApiBase
}
// If we're reporting spam, further munge any email addresses in the report
$emailPattern = "/\b[A-Z0-9!#$%&'*`\/?^{|}~=+_.-]+@[A-Z0-9.-]+\b/i";
$message = preg_replace($emailPattern, "*", $message);
$emailPattern = "/[^@\s]*@[^@\s]*\.[^@\s]*/";
$message = preg_replace($emailPattern, "*", $message);
// Make sure message is less 1024 chars
return substr($message, 0, 1024);

View file

@ -1,20 +1,21 @@
<?php declare(strict_types=1);
/**
* _ ___ ___ ___ ___
* __ _| |__ _ _ ___ ___|_ _| _ \ \| _ )
* / _` | '_ \ || (_-</ -_)| || _/ |) | _ \
* \__,_|_.__/\_,_/__/\___|___|_| |___/|___/
* _ _ ___ ____ ____ ____
* / \ | |__ _ _ ___ ___|_ _| _ \| _ \| __ )
* / _ \ | '_ \| | | / __|/ _ \| || |_) | | | | _ \
* / ___ \| |_) | |_| \__ \ __/| || __/| |_| | |_) |
* /_/ \_\_.__/ \__,_|___/\___|___|_| |____/|____/
*
* This file is part of Kristuff\AbuseIPDB.
* This file is part of Kristuff\AbsuseIPDB.
*
* (c) Kristuff <kristuff@kristuff.fr>
* (c) Kristuff <contact@kristuff.fr>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*
* @version 1.1
* @copyright 2020-2022 Kristuff
* @version 0.9.9
* @copyright 2020-2021 Kristuff
*/
namespace Kristuff\AbuseIPDB;
@ -49,7 +50,7 @@ class ApiResponse
public function __construct(?string $plaintext = null)
{
$this->curlResponse = $plaintext;
$this->decodedResponse = !empty($plaintext) ? json_decode($plaintext, false) : null;
$this->decodedResponse = json_decode($plaintext, false);
}
/**
@ -69,9 +70,9 @@ class ApiResponse
*
* @access public
*
* @return \stdClass|null
* @return object|null
*/
public function getObject(): ?\stdClass
public function getObject(): ?object
{
return $this->decodedResponse;
}
@ -109,29 +110,6 @@ class ApiResponse
*/
public function errors(): array
{
return ($this->decodedResponse && property_exists($this->decodedResponse, 'errors')) ? $this->decodedResponse->errors : [];
}
/**
* Get an internal error message in an ApiResponse object
*
* @access public
* @static
* @param string $message The error message
*
* @return ApiResponse
*/
public static function createErrorResponse(string $message): ApiResponse
{
$response = [
"errors" => [
[
"title" => "Internal Error",
"detail" => $message
]
]
];
return new ApiResponse(json_encode($response));
return ($this->decodedResponse && $this->decodedResponse->errors) ? $this->decodedResponse->errors : [];
}
}

View file

@ -1,20 +1,21 @@
<?php declare(strict_types=1);
/**
* _ ___ ___ ___ ___
* __ _| |__ _ _ ___ ___|_ _| _ \ \| _ )
* / _` | '_ \ || (_-</ -_)| || _/ |) | _ \
* \__,_|_.__/\_,_/__/\___|___|_| |___/|___/
* _ _ ___ ____ ____ ____
* / \ | |__ _ _ ___ ___|_ _| _ \| _ \| __ )
* / _ \ | '_ \| | | / __|/ _ \| || |_) | | | | _ \
* / ___ \| |_) | |_| \__ \ __/| || __/| |_| | |_) |
* /_/ \_\_.__/ \__,_|___/\___|___|_| |____/|____/
*
* This file is part of Kristuff\AbuseIPDB.
* This file is part of Kristuff\AbsuseIPDB.
*
* (c) Kristuff <kristuff@kristuff.fr>
* (c) Kristuff <contact@kristuff.fr>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*
* @version 1.1
* @copyright 2020-2022 Kristuff
* @version 0.9.9
* @copyright 2020-2021 Kristuff
*/
namespace Kristuff\AbuseIPDB;

View file

@ -1,20 +1,21 @@
<?php declare(strict_types=1);
/**
* _ ___ ___ ___ ___
* __ _| |__ _ _ ___ ___|_ _| _ \ \| _ )
* / _` | '_ \ || (_-</ -_)| || _/ |) | _ \
* \__,_|_.__/\_,_/__/\___|___|_| |___/|___/
* _ _ ___ ____ ____ ____
* / \ | |__ _ _ ___ ___|_ _| _ \| _ \| __ )
* / _ \ | '_ \| | | / __|/ _ \| || |_) | | | | _ \
* / ___ \| |_) | |_| \__ \ __/| || __/| |_| | |_) |
* /_/ \_\_.__/ \__,_|___/\___|___|_| |____/|____/
*
* This file is part of Kristuff\AbuseIPDB.
* This file is part of Kristuff\AbsuseIPDB.
*
* (c) Kristuff <kristuff@kristuff.fr>
* (c) Kristuff <contact@kristuff.fr>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*
* @version 1.1
* @copyright 2020-2022 Kristuff
* @version 0.9.9
* @copyright 2020-2021 Kristuff
*/
namespace Kristuff\AbuseIPDB;

View file

@ -1,33 +1,56 @@
<?php declare(strict_types=1);
/**
* _ ___ ___ ___ ___
* __ _| |__ _ _ ___ ___|_ _| _ \ \| _ )
* / _` | '_ \ || (_-</ -_)| || _/ |) | _ \
* \__,_|_.__/\_,_/__/\___|___|_| |___/|___/
* _ _ ___ ____ ____ ____
* / \ | |__ _ _ ___ ___|_ _| _ \| _ \| __ )
* / _ \ | '_ \| | | / __|/ _ \| || |_) | | | | _ \
* / ___ \| |_) | |_| \__ \ __/| || __/| |_| | |_) |
* /_/ \_\_.__/ \__,_|___/\___|___|_| |____/|____/
*
* This file is part of Kristuff\AbuseIPDB.
* This file is part of Kristuff\AbsuseIPDB.
*
* (c) Kristuff <kristuff@kristuff.fr>
* (c) Kristuff <contact@kristuff.fr>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*
* @version 1.1
* @copyright 2020-2022 Kristuff
* @version 0.9.9
* @copyright 2020-2021 Kristuff
*/
namespace Kristuff\AbuseIPDB;
/**
* Class QuietApiHandler
* Class SilentApiHandler
*
* Overwrite ApiHandler with Exception handling
* Instead of Exception, all methods return an ApiResponse that may
* Instead of Exception, all method return an ApiResponse that may
* contains errors from the AbuseIPDB API, or internal errors
*/
class QuietApiHandler extends ApiHandler
class SilentApiHandler extends ApiHandler
{
/**
* Get an internal error message in an ApiResponse object
*
* @access public
* @param string $message The error message
*
* @return ApiResponse
*/
public function getErrorResponse(string $message): ApiResponse
{
$response = [
"errors" => [
[
"title" => "Internal Error",
"detail" => $message
]
]
];
return new ApiResponse(json_encode($response));
}
/**
* Performs a 'report' api request, with Exception handling
*
@ -43,7 +66,7 @@ class QuietApiHandler extends ApiHandler
try {
return parent::report($ip,$categories,$message);
} catch (\Exception $e) {
return ApiResponse::createErrorResponse($e->getMessage());
return $this->getErrorResponse($e->getMessage());
}
}
@ -60,7 +83,7 @@ class QuietApiHandler extends ApiHandler
try {
return parent::bulkReport($filePath);
} catch (\Exception $e) {
return ApiResponse::createErrorResponse($e->getMessage());
return $this->getErrorResponse($e->getMessage());
}
}
@ -77,7 +100,7 @@ class QuietApiHandler extends ApiHandler
try {
return parent::clearAddress($ip);
} catch (\Exception $e) {
return ApiResponse::createErrorResponse($e->getMessage());
return $this->getErrorResponse($e->getMessage());
}
}
@ -96,7 +119,7 @@ class QuietApiHandler extends ApiHandler
try {
return parent::check($ip, $maxAgeInDays, $verbose);
} catch (\Exception $e) {
return ApiResponse::createErrorResponse($e->getMessage());
return $this->getErrorResponse($e->getMessage());
}
}
@ -114,7 +137,7 @@ class QuietApiHandler extends ApiHandler
try {
return parent::checkBlock($network, $maxAgeInDays);
} catch (\Exception $e) {
return ApiResponse::createErrorResponse($e->getMessage());
return $this->getErrorResponse($e->getMessage());
}
}
@ -126,7 +149,7 @@ class QuietApiHandler extends ApiHandler
* @param bool $plainText True to get the response in plaintext list. Default is false
* @param int $confidenceMinimum The abuse confidence score minimum (subscribers feature). Default is 100.
* The confidence minimum must be between 25 and 100.
* This parameter is a subscriber feature (not honored otherwise).
* This parameter is subscriber feature (not honored otherwise).
*
* @return ApiResponse
*/
@ -135,7 +158,7 @@ class QuietApiHandler extends ApiHandler
try {
return parent::blacklist($limit, $plainText, $confidenceMinimum);
} catch (\Exception $e) {
return ApiResponse::createErrorResponse($e->getMessage());
return $this->getErrorResponse($e->getMessage());
}
}
}