https://github.com/solutionforest/filament-firewall
This package provides a whitelist and blacklist feature to restrict access to your Laravel application and Filament admin panel. For additional functionality, please refer to the Laravel Firewall package.
https://github.com/solutionforest/filament-firewall
filament-plugin filamentadmin filamentphp firewall firewall-configuration firewall-management
Last synced: 3 months ago
JSON representation
This package provides a whitelist and blacklist feature to restrict access to your Laravel application and Filament admin panel. For additional functionality, please refer to the Laravel Firewall package.
- Host: GitHub
- URL: https://github.com/solutionforest/filament-firewall
- Owner: solutionforest
- License: mit
- Created: 2023-05-12T04:41:46.000Z (about 2 years ago)
- Default Branch: 2.x
- Last Pushed: 2025-01-08T10:22:16.000Z (6 months ago)
- Last Synced: 2025-03-30T02:04:24.510Z (3 months ago)
- Topics: filament-plugin, filamentadmin, filamentphp, firewall, firewall-configuration, firewall-management
- Language: PHP
- Homepage:
- Size: 31.3 KB
- Stars: 38
- Watchers: 2
- Forks: 11
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
> [!IMPORTANT]
> Please note that we will only be updating to version 2.x, excluding any bug fixes.
## About Solution Forest
[Solution Forest](https://solutionforest.com) Web development agency based in Hong Kong. We help customers to solve their problems. We Love Open Soruces.
We have built a collection of best-in-class products:
- [VantagoAds](https://vantagoads.com): A self manage Ads Server, Simplify Your Advertising Strategy.
- [GatherPro.events](https://gatherpro.events): A Event Photos management tools, Streamline Your Event Photos.
- [Website CMS Management](https://filamentphp.com/plugins/solution-forest-cms-website): Website CMS Management - Filament CMS Plugin
- [Filaletter](https://filaletter.solutionforest.net): Filaletter - Filament Newsletter Plugin
# Filament Firewall
[](https://packagist.org/packages/solution-forest/filament-firewall)
[](https://github.com/solution-forest/filament-firewall/actions?query=workflow%3Arun-tests+branch%3Amain)
[](https://github.com/solution-forest/filament-firewall/actions?query=workflow%3A"Check+%26+fix+styling"+branch%3Amain)
[](https://packagist.org/packages/solution-forest/filament-firewall)
This package provides a whitelist and blacklist feature to restrict access to your Laravel application and Filament admin panel. For additional functionality, please refer to the [Laravel Firewall package](https://github.com/akaunting/laravel-firewall).
## Getting Started
1. Install the package using the `composer require` command:
```php
composer require solution-forest/filament-firewall
```
2. To publish the configuration files and migrations files for this plugin, as well as automatically run migration, enter the following command:
```php
php artisan filament-firewall:install
```
3. This package comes with `WhitelistRangeMiddleware`. You need to register it in `$middleware` in the `app\Http\Kernel.php` file:
```bash
protected $middleware = [
...
\SolutionForest\FilamentFirewall\Middleware\WhitelistRangeMiddleware::class,
];
```
4. You can change the setting in the `config/filament-firewall.php` file to skip the middleware `WhitelistRangeMiddleware` check.
5. Register the plugin in your Panel provider:
> **Important: Register the plugin in your Panel provider after version 2.x**
``` bash
use SolutionForest\FilamentFirewall\FilamentFirewallPanel;
public function panel(Panel $panel): Panel
{
return $panel
->plugin(FilamentFirewallPanel::make());
}
```
## Usage
- On the IP Firewall page, you have the ability to add IPs to either a whitelist or a blocklist. The `WhitelistRangeMiddleware` middleware will automatically handle whitelist IP access. If you need to block a range of IPs while allowing a specific IP, such as blocking *172.19.0.0/24* except for *172.19.0.1*, you'll need to create a new **Deny** access record and specify the IP and prefix as *'172.19.0.0'* and *'24'*. Additionally, you'll need to add an **Allow** access record for the specific IP *'172.19.0.1'*.
- Get whitelist / blacklist records
```php
// whitelist
\SolutionForest\FilamentFirewall\Facade\FilamentFirewall::getWhiteList();
// blacklist
\SolutionForest\FilamentFirewall\Facade\FilamentFirewall::getBlackList();
```
- Determine whether an IP address is included in a whitelist or blacklist
```php
// whitelist
\SolutionForest\FilamentFirewall\Facade\FilamentFirewall::withinWhiteList($ip);
// blacklist
\SolutionForest\FilamentFirewall\Facade\FilamentFirewall::withinBlackList($ip);
```
## Publishing translations
```bash
php artisan vendor:publish --tag=filament-firewall-translations
```
## Security Vulnerabilities
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
## License
Please see [License File](LICENSE.md) for more information.
## Credits
- [Laravel Firewall](https://github.com/akaunting/laravel-firewall)