-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
e0617d6
commit 5b5249b
Showing
2 changed files
with
168 additions
and
167 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,131 +1,131 @@ | ||
| # IP2Proxy Laravel Extension | ||
| [](https://packagist.org/packages/ip2location/ip2proxy-laravel) | ||
| [](https://packagist.org/packages/ip2location/ip2proxy-laravel) | ||
|
|
||
| IP2Proxy Laravel extension enables the user to query an IP address if it was being used as open proxy, web proxy, VPN anonymizer and TOR exits. | ||
|
|
||
| *Note: This extension works in Laravel 6, Laravel 7 and Laravel 8.* | ||
|
|
||
|
|
||
| ## INSTALLATION | ||
|
|
||
| Run the command: `composer require ip2location/ip2proxy-laravel` to download the package into the Laravel platform. | ||
|
|
||
| ## USAGE | ||
|
|
||
| IP2Proxy Laravel extension is able to query the IP address proxy information from either BIN database or web service. This section will explain how to use this extension to query from BIN database and web service. | ||
|
|
||
| ### BIN DATABASE | ||
|
|
||
| 1. Download IP2Proxy BIN database | ||
| - IP2Proxy free LITE database at https://lite.ip2location.com | ||
| - IP2Proxy commercial database at https://www.ip2location.com/proxy-database | ||
| 2. To use IP2Proxy databases, create a folder named as `ip2proxy` in the `database` directory. | ||
| 3. Unzip and copy the BIN file into `database/ip2proxy/` folder. | ||
| 4. Rename the BIN file to IP2PROXY.BIN. | ||
| 5. Create a **TestController** in Laravel using the below command line | ||
| ``` | ||
| php artisan make:controller TestController | ||
| ``` | ||
| 6. Open the **app/Http/Controllers/TestController.php** in any text editor. | ||
| 7. To use IP2Proxy databases, add the below lines into the controller file | ||
| ```php | ||
| <?php | ||
|
|
||
| namespace App\Http\Controllers; | ||
|
|
||
| use Illuminate\Http\Request; | ||
| use IP2ProxyLaravel; //use IP2ProxyLaravel class | ||
|
|
||
| class TestController extends Controller | ||
| { | ||
| //Create a lookup function for display | ||
| public function lookup(){ | ||
| //Try query the geolocation information of 1.2.3.4 IP address | ||
| $records = IP2ProxyLaravel::get('1.2.3.4', 'bin'); | ||
|
|
||
| echo '<p><strong>IP Address: </strong>' . $records['ipAddress'] . '</p>'; | ||
| echo '<p><strong>IP Number: </strong>' . $records['ipNumber'] . '</p>'; | ||
| echo '<p><strong>IP Version: </strong>' . $records['ipVersion'] . '</p>'; | ||
| echo '<p><strong>Country Code: </strong>' . $records['countryCode'] . '</p>'; | ||
| echo '<p><strong>Country: </strong>' . $records['countryName'] . '</p>'; | ||
| echo '<p><strong>State: </strong>' . $records['regionName'] . '</p>'; | ||
| echo '<p><strong>City: </strong>' . $records['cityName'] . '</p>'; | ||
| echo '<p><strong>Proxy Type: </strong>' . $records['proxyType'] . '</p>'; | ||
| echo '<p><strong>Is Proxy: </strong>' . $records['isProxy'] . '</p>'; | ||
| echo '<p><strong>ISP: </strong>' . $records['isp'] . '</p>'; | ||
| echo '<p><strong>Domain: </strong>' . $records['domain'] . '</p>'; | ||
| echo '<p><strong>Usage Type: </strong>' . $records['usageType'] . '</p>'; | ||
| echo '<p><strong>ASN: </strong>' . $records['asn'] . '</p>'; | ||
| echo '<p><strong>AS: </strong>' . $records['as'] . '</p>'; | ||
| echo '<p><strong>Last Seen: </strong>' . $records['lastSeen'] . '</p>'; | ||
| echo '<p><strong>Threat: </strong>' . $records['threat'] . '</p>'; | ||
| echo '<p><strong>Provider: </strong>' . $records['provider'] . '</p>'; | ||
| } | ||
| } | ||
| ``` | ||
| 8. Add the following line into the *routes/web.php* file. | ||
| ``` | ||
| Route::get('test', 'TestController@lookup'); | ||
| ``` | ||
| 9. Enter the URL <your domain>/public/test and run. You should see the information of **1.2.3.4** IP address. | ||
|
|
||
| ### WEB SERVICE | ||
|
|
||
| 1. To use IP2Proxy Web Service, create a new file called "site_vars.php" in `config` directory. | ||
| 2. In the site_vars.php, save the following contents: | ||
| ```php | ||
| <?php | ||
| return [ | ||
| 'IP2ProxyAPIKey' => 'your_api_key', // Required. Your IP2Proxy API key. | ||
| 'IP2ProxyPackage' => 'PX1', // Required. Choose the package you would like to use. | ||
| 'IP2ProxyUsessl' => false, // Optional. Use https or http. | ||
| ]; | ||
| ``` | ||
| 3. Create a **TestController** in Laravel using the below command line | ||
| ``` | ||
| php artisan make:controller TestController | ||
| ``` | ||
| 4. Open the **app/Http/Controllers/TestController.php** in any text editor. | ||
| 5. To use IP2Proxy Web Service, add the below lines into the controller file. | ||
| ```php | ||
| <?php | ||
|
|
||
| namespace App\Http\Controllers; | ||
|
|
||
| use Illuminate\Http\Request; | ||
|
|
||
| use IP2ProxyLaravel; //use IP2ProxyLaravel class | ||
|
|
||
| class TestController extends Controller | ||
| { | ||
| //Create a lookup function for display | ||
| public function lookup(){ | ||
| //Try query the geolocation information of 1.2.3.4 IP address | ||
| $records = IP2ProxyLaravel::get('1.2.3.4', 'ws'); | ||
|
|
||
| echo '<pre>'; | ||
| print_r($records); | ||
| echo '</pre>'; | ||
| } | ||
| } | ||
|
|
||
| ``` | ||
| 6. Add the following line into the *routes/web.php* file. | ||
| ``` | ||
| Route::get('test', 'TestController@lookup'); | ||
| ``` | ||
| 7. Enter the URL <your domain>/public/test and run. You should see the information of **1.2.3.4** IP address. | ||
|
|
||
| ## DEPENDENCIES (IP2PROXY BIN DATA FILE) | ||
|
|
||
| This library requires IP2Proxy BIN data file to function. You may download the BIN data file at | ||
| * IP2Proxy LITE BIN Data (Free): https://lite.ip2location.com | ||
| * IP2Proxy Commercial BIN Data (Comprehensive): https://www.ip2location.com/proxy-database | ||
|
|
||
|
|
||
| ## SUPPORT | ||
|
|
||
| Email: support@ip2location.com | ||
|
|
||
| Website: https://www.ip2location.com | ||
| # IP2Proxy Laravel Extension | ||
| [](https://packagist.org/packages/ip2location/ip2proxy-laravel) | ||
| [](https://packagist.org/packages/ip2location/ip2proxy-laravel) | ||
|
|
||
| IP2Proxy Laravel extension enables the user to query an IP address if it was being used as open proxy, web proxy, VPN anonymizer and TOR exits. | ||
|
|
||
| *Note: This extension works in Laravel 6, Laravel 7, Laravel 8 and Laravel 9.* | ||
|
|
||
|
|
||
| ## INSTALLATION | ||
|
|
||
| Run the command: `composer require ip2location/ip2proxy-laravel` to download the package into the Laravel platform. | ||
|
|
||
| ## USAGE | ||
|
|
||
| IP2Proxy Laravel extension is able to query the IP address proxy information from either BIN database or web service. This section will explain how to use this extension to query from BIN database and web service. | ||
|
|
||
| ### BIN DATABASE | ||
|
|
||
| 1. Download IP2Proxy BIN database | ||
| - IP2Proxy free LITE database at https://lite.ip2location.com | ||
| - IP2Proxy commercial database at https://www.ip2location.com/proxy-database | ||
| 2. To use IP2Proxy databases, create a folder named as `ip2proxy` in the `database` directory. | ||
| 3. Unzip and copy the BIN file into `database/ip2proxy/` folder. | ||
| 4. Rename the BIN file to IP2PROXY.BIN. | ||
| 5. Create a **TestController** in Laravel using the below command line | ||
| ``` | ||
| php artisan make:controller TestController | ||
| ``` | ||
| 6. Open the **app/Http/Controllers/TestController.php** in any text editor. | ||
| 7. To use IP2Proxy databases, add the below lines into the controller file | ||
| ```php | ||
| <?php | ||
|
|
||
| namespace App\Http\Controllers; | ||
|
|
||
| use Illuminate\Http\Request; | ||
| use IP2ProxyLaravel; //use IP2ProxyLaravel class | ||
|
|
||
| class TestController extends Controller | ||
| { | ||
| //Create a lookup function for display | ||
| public function lookup(){ | ||
| //Try query the geolocation information of 1.2.3.4 IP address | ||
| $records = IP2ProxyLaravel::get('1.2.3.4', 'bin'); | ||
|
|
||
| echo '<p><strong>IP Address: </strong>' . $records['ipAddress'] . '</p>'; | ||
| echo '<p><strong>IP Number: </strong>' . $records['ipNumber'] . '</p>'; | ||
| echo '<p><strong>IP Version: </strong>' . $records['ipVersion'] . '</p>'; | ||
| echo '<p><strong>Country Code: </strong>' . $records['countryCode'] . '</p>'; | ||
| echo '<p><strong>Country: </strong>' . $records['countryName'] . '</p>'; | ||
| echo '<p><strong>State: </strong>' . $records['regionName'] . '</p>'; | ||
| echo '<p><strong>City: </strong>' . $records['cityName'] . '</p>'; | ||
| echo '<p><strong>Proxy Type: </strong>' . $records['proxyType'] . '</p>'; | ||
| echo '<p><strong>Is Proxy: </strong>' . $records['isProxy'] . '</p>'; | ||
| echo '<p><strong>ISP: </strong>' . $records['isp'] . '</p>'; | ||
| echo '<p><strong>Domain: </strong>' . $records['domain'] . '</p>'; | ||
| echo '<p><strong>Usage Type: </strong>' . $records['usageType'] . '</p>'; | ||
| echo '<p><strong>ASN: </strong>' . $records['asn'] . '</p>'; | ||
| echo '<p><strong>AS: </strong>' . $records['as'] . '</p>'; | ||
| echo '<p><strong>Last Seen: </strong>' . $records['lastSeen'] . '</p>'; | ||
| echo '<p><strong>Threat: </strong>' . $records['threat'] . '</p>'; | ||
| echo '<p><strong>Provider: </strong>' . $records['provider'] . '</p>'; | ||
| } | ||
| } | ||
| ``` | ||
| 8. Add the following line into the *routes/web.php* file. | ||
| ``` | ||
| Route::get('test', 'TestController@lookup'); | ||
| ``` | ||
| 9. Enter the URL <your domain>/public/test and run. You should see the information of **1.2.3.4** IP address. | ||
|
|
||
| ### WEB SERVICE | ||
|
|
||
| 1. To use IP2Proxy Web Service, create a new file called "site_vars.php" in `config` directory. | ||
| 2. In the site_vars.php, save the following contents: | ||
| ```php | ||
| <?php | ||
| return [ | ||
| 'IP2ProxyAPIKey' => 'your_api_key', // Required. Your IP2Proxy API key. | ||
| 'IP2ProxyPackage' => 'PX1', // Required. Choose the package you would like to use. | ||
| 'IP2ProxyUsessl' => false, // Optional. Use https or http. | ||
| ]; | ||
| ``` | ||
| 3. Create a **TestController** in Laravel using the below command line | ||
| ``` | ||
| php artisan make:controller TestController | ||
| ``` | ||
| 4. Open the **app/Http/Controllers/TestController.php** in any text editor. | ||
| 5. To use IP2Proxy Web Service, add the below lines into the controller file. | ||
| ```php | ||
| <?php | ||
|
|
||
| namespace App\Http\Controllers; | ||
|
|
||
| use Illuminate\Http\Request; | ||
|
|
||
| use IP2ProxyLaravel; //use IP2ProxyLaravel class | ||
|
|
||
| class TestController extends Controller | ||
| { | ||
| //Create a lookup function for display | ||
| public function lookup(){ | ||
| //Try query the geolocation information of 1.2.3.4 IP address | ||
| $records = IP2ProxyLaravel::get('1.2.3.4', 'ws'); | ||
|
|
||
| echo '<pre>'; | ||
| print_r($records); | ||
| echo '</pre>'; | ||
| } | ||
| } | ||
|
|
||
| ``` | ||
| 6. Add the following line into the *routes/web.php* file. | ||
| ``` | ||
| Route::get('test', 'TestController@lookup'); | ||
| ``` | ||
| 7. Enter the URL <your domain>/public/test and run. You should see the information of **1.2.3.4** IP address. | ||
|
|
||
| ## DEPENDENCIES (IP2PROXY BIN DATA FILE) | ||
|
|
||
| This library requires IP2Proxy BIN data file to function. You may download the BIN data file at | ||
| * IP2Proxy LITE BIN Data (Free): https://lite.ip2location.com | ||
| * IP2Proxy Commercial BIN Data (Comprehensive): https://www.ip2location.com/proxy-database | ||
|
|
||
|
|
||
| ## SUPPORT | ||
|
|
||
| Email: support@ip2location.com | ||
|
|
||
| Website: https://www.ip2location.com |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,36 +1,37 @@ | ||
| { | ||
| "name": "ip2location/ip2proxy-laravel", | ||
| "description": "Allows user to query an IP address if it was being used as open proxy, web proxy, VPN anonymizer and TOR exits.", | ||
| "license": "MIT", | ||
| "keywords": [ | ||
| "laravel", | ||
| "laravel 6", | ||
| "laravel 7", | ||
| "laravel 8", | ||
| "IP2Proxy", | ||
| "proxy" | ||
| ], | ||
| "authors": [ | ||
| { | ||
| "name": "IP2Location", | ||
| "email": "support@ip2location.com" | ||
| } | ||
| ], | ||
| "minimum-stability": "stable", | ||
| "require": { | ||
| "php": ">=5.4", | ||
| "ip2location/ip2proxy-php": ">=4" | ||
| }, | ||
| "autoload": { | ||
| "psr-4": { | ||
| "Ip2location\\IP2ProxyLaravel\\": "src/" | ||
| } | ||
| }, | ||
| "extra": { | ||
| "laravel": { | ||
| "providers": [ | ||
| "Ip2location\\IP2ProxyLaravel\\IP2ProxyLaravelServiceProvider" | ||
| ] | ||
| } | ||
| } | ||
| } | ||
| { | ||
| "name": "ip2location/ip2proxy-laravel", | ||
| "description": "Allows user to query an IP address if it was being used as open proxy, web proxy, VPN anonymizer and TOR exits.", | ||
| "license": "MIT", | ||
| "keywords": [ | ||
| "laravel", | ||
| "laravel 6", | ||
| "laravel 7", | ||
| "laravel 8", | ||
| "laravel 9", | ||
| "IP2Proxy", | ||
| "proxy" | ||
| ], | ||
| "authors": [ | ||
| { | ||
| "name": "IP2Location", | ||
| "email": "support@ip2location.com" | ||
| } | ||
| ], | ||
| "minimum-stability": "stable", | ||
| "require": { | ||
| "php": ">=5.4", | ||
| "ip2location/ip2proxy-php": ">=4" | ||
| }, | ||
| "autoload": { | ||
| "psr-4": { | ||
| "Ip2location\\IP2ProxyLaravel\\": "src/" | ||
| } | ||
| }, | ||
| "extra": { | ||
| "laravel": { | ||
| "providers": [ | ||
| "Ip2location\\IP2ProxyLaravel\\IP2ProxyLaravelServiceProvider" | ||
| ] | ||
| } | ||
| } | ||
| } |