Compare commits

..

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

8 changed files with 63 additions and 107 deletions

View file

@ -1,6 +1,6 @@
MIT License 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 Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal of this software and associated documentation files (the "Software"), to deal

View file

@ -16,8 +16,7 @@ Features
- Single IP report request **✓** - Single IP report request **✓**
- Bulk report request (send `csv` file) **✓** - Bulk report request (send `csv` file) **✓**
- Clear IP address request (remove your own reports) **✓** - Clear IP address request (remove your own reports) **✓**
- Auto cleaning report comments from sensitive data (email, custom ip/domain names list) **✓** - Auto cleaning report comments from sensitive data (email, custom ip/domain names list) **✓**
- Define timeout for cURL internal requests **✓**
Requirements Requirements
------------ ------------
@ -33,7 +32,7 @@ Deploy with composer:
```json ```json
... ...
"require": { "require": {
"kristuff/abuseipdb": "^1.1-stable" "kristuff/abuseipdb": "^0.9.13-stable"
}, },
``` ```
@ -50,7 +49,7 @@ License
The MIT License (MIT) 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 Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal of this software and associated documentation files (the "Software"), to deal

View file

@ -1,10 +1,11 @@
<?php declare(strict_types=1); <?php declare(strict_types=1);
/** /**
* _ ___ ___ ___ ___ * _ _ ___ ____ ____ ____
* __ _| |__ _ _ ___ ___|_ _| _ \ \| _ ) * / \ | |__ _ _ ___ ___|_ _| _ \| _ \| __ )
* / _` | '_ \ || (_-</ -_)| || _/ |) | _ \ * / _ \ | '_ \| | | / __|/ _ \| || |_) | | | | _ \
* \__,_|_.__/\_,_/__/\___|___|_| |___/|___/ * / ___ \| |_) | |_| \__ \ __/| || __/| |_| | |_) |
* /_/ \_\_.__/ \__,_|___/\___|___|_| |____/|____/
* *
* This file is part of Kristuff\AbuseIPDB. * This file is part of Kristuff\AbuseIPDB.
* *
@ -13,8 +14,8 @@
* For the full copyright and license information, please view the LICENSE * For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code. * file that was distributed with this source code.
* *
* @version 1.1 * @version 0.9.13
* @copyright 2020-2022 Kristuff * @copyright 2020-2021 Kristuff
*/ */
namespace Kristuff\AbuseIPDB; namespace Kristuff\AbuseIPDB;

View file

@ -1,10 +1,11 @@
<?php declare(strict_types=1); <?php declare(strict_types=1);
/** /**
* _ ___ ___ ___ ___ * _ _ ___ ____ ____ ____
* __ _| |__ _ _ ___ ___|_ _| _ \ \| _ ) * / \ | |__ _ _ ___ ___|_ _| _ \| _ \| __ )
* / _` | '_ \ || (_-</ -_)| || _/ |) | _ \ * / _ \ | '_ \| | | / __|/ _ \| || |_) | | | | _ \
* \__,_|_.__/\_,_/__/\___|___|_| |___/|___/ * / ___ \| |_) | |_| \__ \ __/| || __/| |_| | |_) |
* /_/ \_\_.__/ \__,_|___/\___|___|_| |____/|____/
* *
* This file is part of Kristuff\AbuseIPDB. * This file is part of Kristuff\AbuseIPDB.
* *
@ -13,8 +14,8 @@
* For the full copyright and license information, please view the LICENSE * For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code. * file that was distributed with this source code.
* *
* @version 1.1 * @version 0.9.13
* @copyright 2020-2022 Kristuff * @copyright 2020-2021 Kristuff
*/ */
namespace Kristuff\AbuseIPDB; namespace Kristuff\AbuseIPDB;
@ -34,7 +35,7 @@ class ApiHandler extends ApiBase
/** /**
* @var string * @var string
*/ */
const VERSION = 'v1.1'; const VERSION = 'v0.9.13';
/** /**
* The ips to remove from report messages * The ips to remove from report messages
@ -45,46 +46,18 @@ class ApiHandler extends ApiBase
*/ */
protected $selfIps = []; 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 * Constructor
* *
* @access public * @access public
* @param string $apiKey The AbuseIPDB api key * @param string $apiKey The AbuseIPDB api key
* @param array $myIps The Ips/domain name you don't want to display in report messages * @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->aipdbApiKey = $apiKey;
$this->selfIps = $myIps; $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( return array(
'apiKey' => $this->aipdbApiKey, 'apiKey' => $this->aipdbApiKey,
'selfIps' => $this->selfIps, 'selfIps' => $this->selfIps,
'timeout' => $this->timeout,
); );
} }
@ -188,7 +160,6 @@ class ApiHandler extends ApiBase
* @return ApiResponse * @return ApiResponse
* @throws \RuntimeException * @throws \RuntimeException
* @throws \InvalidArgumentException * @throws \InvalidArgumentException
* @throws InvalidPermissionException
*/ */
public function bulkReport(string $filePath): ApiResponse 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 protected function apiRequest(string $path, array $data, string $method = 'GET', string $csvFilePath = ''): ApiResponse
{ {
$curlErrorNumber = -1; // will be used later to check curl execution // set api url
$curlErrorMessage = ''; $url = $this->aipdbApiEndpoint . $path;
$url = $this->aipdbApiEndpoint . $path; // api url
// set the wanted format, JSON (required to prevent having full html page on error) // set the wanted format, JSON (required to prevent having full html page on error)
// and the AbuseIPDB API Key as a header // and the AbuseIPDB API Key as a header
@ -416,35 +386,17 @@ class ApiHandler extends ApiBase
$url .= '?' . http_build_query($data); $url .= '?' . http_build_query($data);
} }
// set url and options // set the url to call
$this->setCurlOption($ch, CURLOPT_URL, $url); $this->setCurlOption($ch, CURLOPT_URL, $url);
$this->setCurlOption($ch, CURLOPT_RETURNTRANSFER, 1); $this->setCurlOption($ch, CURLOPT_RETURNTRANSFER, 1);
$this->setCurlOption($ch, CURLOPT_HTTPHEADER, $headers); $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 // execute curl call
$result = curl_exec($ch); $result = curl_exec($ch);
$curlErrorNumber = curl_errno($ch);
$curlErrorMessage = curl_error($ch);
// close connection // close connection
curl_close($ch); curl_close($ch);
if ($curlErrorNumber !== 0){
throw new \RuntimeException($curlErrorMessage);
}
return new ApiResponse($result !== false ? $result : ''); 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 // 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); $message = preg_replace($emailPattern, "*", $message);
// Make sure message is less 1024 chars // Make sure message is less 1024 chars
return substr($message, 0, 1024); return substr($message, 0, 1024);

View file

@ -1,10 +1,11 @@
<?php declare(strict_types=1); <?php declare(strict_types=1);
/** /**
* _ ___ ___ ___ ___ * _ _ ___ ____ ____ ____
* __ _| |__ _ _ ___ ___|_ _| _ \ \| _ ) * / \ | |__ _ _ ___ ___|_ _| _ \| _ \| __ )
* / _` | '_ \ || (_-</ -_)| || _/ |) | _ \ * / _ \ | '_ \| | | / __|/ _ \| || |_) | | | | _ \
* \__,_|_.__/\_,_/__/\___|___|_| |___/|___/ * / ___ \| |_) | |_| \__ \ __/| || __/| |_| | |_) |
* /_/ \_\_.__/ \__,_|___/\___|___|_| |____/|____/
* *
* This file is part of Kristuff\AbuseIPDB. * This file is part of Kristuff\AbuseIPDB.
* *
@ -13,8 +14,8 @@
* For the full copyright and license information, please view the LICENSE * For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code. * file that was distributed with this source code.
* *
* @version 1.1 * @version 0.9.13
* @copyright 2020-2022 Kristuff * @copyright 2020-2021 Kristuff
*/ */
namespace Kristuff\AbuseIPDB; namespace Kristuff\AbuseIPDB;

View file

@ -1,10 +1,11 @@
<?php declare(strict_types=1); <?php declare(strict_types=1);
/** /**
* _ ___ ___ ___ ___ * _ _ ___ ____ ____ ____
* __ _| |__ _ _ ___ ___|_ _| _ \ \| _ ) * / \ | |__ _ _ ___ ___|_ _| _ \| _ \| __ )
* / _` | '_ \ || (_-</ -_)| || _/ |) | _ \ * / _ \ | '_ \| | | / __|/ _ \| || |_) | | | | _ \
* \__,_|_.__/\_,_/__/\___|___|_| |___/|___/ * / ___ \| |_) | |_| \__ \ __/| || __/| |_| | |_) |
* /_/ \_\_.__/ \__,_|___/\___|___|_| |____/|____/
* *
* This file is part of Kristuff\AbuseIPDB. * This file is part of Kristuff\AbuseIPDB.
* *
@ -13,8 +14,8 @@
* For the full copyright and license information, please view the LICENSE * For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code. * file that was distributed with this source code.
* *
* @version 1.1 * @version 0.9.13
* @copyright 2020-2022 Kristuff * @copyright 2020-2021 Kristuff
*/ */
namespace Kristuff\AbuseIPDB; namespace Kristuff\AbuseIPDB;

View file

@ -1,10 +1,11 @@
<?php declare(strict_types=1); <?php declare(strict_types=1);
/** /**
* _ ___ ___ ___ ___ * _ _ ___ ____ ____ ____
* __ _| |__ _ _ ___ ___|_ _| _ \ \| _ ) * / \ | |__ _ _ ___ ___|_ _| _ \| _ \| __ )
* / _` | '_ \ || (_-</ -_)| || _/ |) | _ \ * / _ \ | '_ \| | | / __|/ _ \| || |_) | | | | _ \
* \__,_|_.__/\_,_/__/\___|___|_| |___/|___/ * / ___ \| |_) | |_| \__ \ __/| || __/| |_| | |_) |
* /_/ \_\_.__/ \__,_|___/\___|___|_| |____/|____/
* *
* This file is part of Kristuff\AbuseIPDB. * This file is part of Kristuff\AbuseIPDB.
* *
@ -13,8 +14,8 @@
* For the full copyright and license information, please view the LICENSE * For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code. * file that was distributed with this source code.
* *
* @version 1.1 * @version 0.9.13
* @copyright 2020-2022 Kristuff * @copyright 2020-2021 Kristuff
*/ */
namespace Kristuff\AbuseIPDB; namespace Kristuff\AbuseIPDB;

View file

@ -1,10 +1,11 @@
<?php declare(strict_types=1); <?php declare(strict_types=1);
/** /**
* _ ___ ___ ___ ___ * _ _ ___ ____ ____ ____
* __ _| |__ _ _ ___ ___|_ _| _ \ \| _ ) * / \ | |__ _ _ ___ ___|_ _| _ \| _ \| __ )
* / _` | '_ \ || (_-</ -_)| || _/ |) | _ \ * / _ \ | '_ \| | | / __|/ _ \| || |_) | | | | _ \
* \__,_|_.__/\_,_/__/\___|___|_| |___/|___/ * / ___ \| |_) | |_| \__ \ __/| || __/| |_| | |_) |
* /_/ \_\_.__/ \__,_|___/\___|___|_| |____/|____/
* *
* This file is part of Kristuff\AbuseIPDB. * This file is part of Kristuff\AbuseIPDB.
* *
@ -13,8 +14,8 @@
* For the full copyright and license information, please view the LICENSE * For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code. * file that was distributed with this source code.
* *
* @version 1.1 * @version 0.9.13
* @copyright 2020-2022 Kristuff * @copyright 2020-2021 Kristuff
*/ */
namespace Kristuff\AbuseIPDB; namespace Kristuff\AbuseIPDB;