 Download<p align="center"> <img src="laraguard-ip-logo.png" alt="laraguard-ip Logo" style="width: 100%; max-width: 800px;" />
</p>
<h1>? Laraguard-IP</h1>
A powerful Laravel package to protect your application using IP-based, country-based, and spam-blacklist-based middleware.
<p align="center">
<a href="https://packagist.org/packages/haxneeraj/laraguard-ip"><img src="https://img.shields.io/packagist/dt/haxneeraj/laraguard-ip" alt="Total Downloads"></a>
<a href="https://packagist.org/packages/haxneeraj/laraguard-ip"><img src="https://img.shields.io/packagist/v/haxneeraj/laraguard-ip" alt="Latest Stable Version"></a>
<a href="https://packagist.org/packages/haxneeraj/laraguard-ip"><img src="https://img.shields.io/packagist/l/haxneeraj/laraguard-ip" alt="License"></a>
</p>
> Created with ?? by Neeraj Saini _(opens in new tab)_
? Features
-
? IP Whitelist Only Mode
-
? Country Whitelist Mode (GeoIP-based) (COMING SOON)
-
? Spam Protection using blocklists (like AbuseIPDB)
-
? IP compression & JSON-based caching
-
?? Middleware-based access control
-
?? Artisan command to fetch & cache spam IPs
? Installation
composer require haxneeraj/laraguard-ip
? Configuration
1. Add the Service Provider
Add the service provider to the config/app.php file (this step may be optional if you're using Laravel's package auto-discovery):
For Laravel 10 and below:
'providers' => [
// Other service providers...
Haxneeraj\LaraguardIp\Providers\LaraguardIpServiceProvider::class,
],
For Laravel 11:
Add the service provider to the bootstrap/providers.php file (this step may be optional if you're using Laravel's package auto-discovery):
return [
// Other service providers...
Haxneeraj\LaraguardIp\Providers\LaraguardIpServiceProvider::class,
];
2. Publish the config file
php artisan vendor:publish --provider="Haxneeraj\LaraguardIp\Providers\LaraguardIpServiceProvider" --tag=config
This will create a config file at:
config/laraguard-ip.php
? Middleware Usage
The middleware is automatically registered via the package's service provider.
You can directly use it in your routes like this:
Apply to Routes
Route::middleware(['laraguard-ip'])->group(function () {
// Protected routes
});
?? Configuration Options
Here's a summary of available config values:
| Key | Description | Default |
| ----------------------------- | ----------------------------------- | ------------------------------------------- |
| laraguardip_spam_protection | Enable blocklist protection | false |
| whitelist_only_access | Only allow IPs in whitelist_ips | false |
| country_whitelist_only | Only allow from country_whitelist | false |
| whitelist_ips | Safe IPs | ['127.0.0.1'] |
| country_whitelist | Allowed ISO country codes | ['IN', 'US'] |
| sources | Blocklist sources (URL) | AbuseIPDB |
| path | Blocklist storage path | storage/framework/cache/laraguard-ip.json |
| compress | Enable IP compression | true |
? Fetch & Cache Blacklist IPs
You can fetch and store the latest spam IPs from the defined sources:
php artisan laraguardip:update
-
Downloads IPs from `config('laraguard-ip.sources')`
-
Saves to `laraguard-ip.json`
-
Caches the list forever using Laravel's Cache
? How It Works
-
? Denies access if IP is not whitelisted (if enabled)
-
? Blocks requests from unwanted countries (if enabled)
-
? Checks IPs against blacklist
-
? Cache and config driven ? no DB required
? Example .env
LARAGUARDIP_SPAM_PROTECTION=true
LARAGUARDIP_WHITELIST_ONLY=false
LARAGUARDIP_COUNTRY_WHITELIST_ONLY=false
LARAGUARDIP_STORAGE_PATH=framework/cache/laraguard-ip.json
LARAGUARDIP_STORAGE_COMPRESS=true
? Tests
This package comes with feature and unit tests to ensure everything works smoothly.
? Run Tests
composer test
? Want to Contribute?
Pull requests are welcome! Feel free to fork, raise issues or drop ideas.
? License
MIT © Neeraj Saini _(opens in new tab)_
|
