Documentation

• Filament Firewall
  • Getting Started
  • Usage
  • Publishing translations
  • Security Vulnerabilities
  • License
  • Credits

#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.

#Getting Started

1. Install the package using the composer require command:

   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 artisan filament-firewall:install

3. This package comes with WhitelistRangeMiddleware. You need to register it in $middleware in the app\Http\Kernel.php file:

   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.

#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

  // whitelist
  \SolutionForest\FilamentFirewall\Facade\FilamentFirewall::getWhiteList();
   
  // blacklist
  \SolutionForest\FilamentFirewall\Facade\FilamentFirewall::getBlackList();

• Determine whether an IP address is included in a whitelist or blacklist

  // whitelist
  \SolutionForest\FilamentFirewall\Facade\FilamentFirewall::withinWhiteList($ip);
   
  // blacklist
  \SolutionForest\FilamentFirewall\Facade\FilamentFirewall::withinBlackList($ip);

#Publishing translations

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 for more information.

#Credits

• Laravel Firewall