mirror of
https://github.com/kristuff/abuseipdb
synced 2025-08-22 14:24:32 -07:00
Compare commits
No commits in common. "master" and "v0.9.10" have entirely different histories.
10 changed files with 89 additions and 132 deletions
2
.gitignore
vendored
2
.gitignore
vendored
|
|
@ -1 +1,3 @@
|
|||
_*
|
||||
.old*
|
||||
vendor/*
|
||||
2
LICENSE
2
LICENSE
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -17,7 +17,6 @@ Features
|
|||
- 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 **✓**
|
||||
|
||||
Requirements
|
||||
------------
|
||||
|
|
@ -33,7 +32,7 @@ Deploy with composer:
|
|||
```json
|
||||
...
|
||||
"require": {
|
||||
"kristuff/abuseipdb": "^1.1-stable"
|
||||
"kristuff/abuseipdb": ">=0.9.10-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
|
||||
|
|
|
|||
|
|
@ -7,9 +7,7 @@
|
|||
"authors": [
|
||||
{
|
||||
"name": "Kristuff",
|
||||
"homepage": "https://github.com/kristuff",
|
||||
"email": "kristuff@kristuff.fr",
|
||||
"role": "Developer"
|
||||
"homepage": "https://github.com/kristuff"
|
||||
}
|
||||
],
|
||||
"require": {
|
||||
|
|
|
|||
|
|
@ -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.10
|
||||
* @copyright 2020-2021 Kristuff
|
||||
*/
|
||||
|
||||
namespace Kristuff\AbuseIPDB;
|
||||
|
|
@ -43,8 +44,8 @@ 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
|
||||
|
|
@ -127,7 +128,7 @@ 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],
|
||||
];
|
||||
|
||||
/**
|
||||
|
|
@ -152,11 +153,11 @@ abstract class ApiBase
|
|||
*
|
||||
* @return string|bool The category id in string format if found, otherwise false
|
||||
*/
|
||||
public static function getCategoryIdByName(string $categoryName)
|
||||
public static function getCategoryIdbyName(string $categoryName)
|
||||
{
|
||||
foreach (self::$aipdbApiCategories as $cat){
|
||||
if ($cat[0] === $categoryName) {
|
||||
return $cat[1];
|
||||
return $cat;
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -177,7 +178,7 @@ abstract class ApiBase
|
|||
{
|
||||
foreach (self::$aipdbApiCategories as $cat){
|
||||
if ($cat[1] === $categoryId) {
|
||||
return $cat[0];
|
||||
return $cat;
|
||||
}
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -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.10
|
||||
* @copyright 2020-2021 Kristuff
|
||||
*/
|
||||
|
||||
namespace Kristuff\AbuseIPDB;
|
||||
|
|
@ -34,7 +35,7 @@ class ApiHandler extends ApiBase
|
|||
/**
|
||||
* @var string
|
||||
*/
|
||||
const VERSION = 'v1.1';
|
||||
const VERSION = 'v0.9.10';
|
||||
|
||||
/**
|
||||
* 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
|
||||
{
|
||||
|
|
@ -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,7 +421,7 @@ 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";
|
||||
$emailPattern = "/[^@\s]*@[^@\s]*\.[^@\s]*/";
|
||||
$message = preg_replace($emailPattern, "*", $message);
|
||||
|
||||
// Make sure message is less 1024 chars
|
||||
|
|
|
|||
|
|
@ -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.10
|
||||
* @copyright 2020-2021 Kristuff
|
||||
*/
|
||||
|
||||
namespace Kristuff\AbuseIPDB;
|
||||
|
|
@ -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,7 +110,7 @@ class ApiResponse
|
|||
*/
|
||||
public function errors(): array
|
||||
{
|
||||
return ($this->decodedResponse && property_exists($this->decodedResponse, 'errors')) ? $this->decodedResponse->errors : [];
|
||||
return ($this->decodedResponse && $this->decodedResponse->errors) ? $this->decodedResponse->errors : [];
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -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.10
|
||||
* @copyright 2020-2021 Kristuff
|
||||
*/
|
||||
|
||||
namespace Kristuff\AbuseIPDB;
|
||||
|
|
|
|||
|
|
@ -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.10
|
||||
* @copyright 2020-2021 Kristuff
|
||||
*/
|
||||
|
||||
namespace Kristuff\AbuseIPDB;
|
||||
|
|
|
|||
|
|
@ -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.10
|
||||
* @copyright 2020-2021 Kristuff
|
||||
*/
|
||||
|
||||
namespace Kristuff\AbuseIPDB;
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue