Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/akaunting/laravel-firewall
Web Application Firewall (WAF) package for Laravel
https://github.com/akaunting/laravel-firewall
akaunting blacklist firewall laravel php security waf whitelist
Last synced: 3 days ago
JSON representation
Web Application Firewall (WAF) package for Laravel
- Host: GitHub
- URL: https://github.com/akaunting/laravel-firewall
- Owner: akaunting
- License: mit
- Created: 2019-07-16T17:53:52.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-03-19T21:53:31.000Z (8 months ago)
- Last Synced: 2024-08-11T17:10:15.311Z (3 months ago)
- Topics: akaunting, blacklist, firewall, laravel, php, security, waf, whitelist
- Language: PHP
- Homepage: https://akaunting.com
- Size: 103 KB
- Stars: 927
- Watchers: 17
- Forks: 104
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Web Application Firewall (WAF) package for Laravel
[](https://styleci.io/repos/197242392)
[](LICENSE.md)
This package intends to protect your Laravel app from different type of attacks such as XSS, SQLi, RFI, LFI, User Agent, and a lot more. It will also block repeated attacks and send notification via email and/or slack when attack is detected. Furthermore, it will log failed logins and block the IP after a number of attempts.
Note: Some middleware classes (i.e. Xss) are empty as the `Middleware` abstract class that they extend does all of the job, dynamically. In short, they all works ;)
## Getting Started
### 1. Install
Run the following command:
```bash
composer require akaunting/laravel-firewall
```
### 2. Publish
Publish configuration, language, and migrations
```bash
php artisan vendor:publish --tag=firewall
```
### 3. Database
Create db tables
```bash
php artisan migrate
```
### 4. Configure
You can change the firewall settings of your app from `config/firewall.php` file
## Usage
Middlewares are already defined so should just add them to routes. The `firewall.all` middleware applies all the middlewares available in the `all_middleware` array of config file.
```php
Route::group(['middleware' => 'firewall.all'], function () {
Route::get('/', 'HomeController@index');
});
```
You can apply each middleware per route. For example, you can allow only whitelisted IPs to access admin:
```php
Route::group(['middleware' => 'firewall.whitelist'], function () {
Route::get('/admin', 'AdminController@index');
});
```
Or you can get notified when anyone NOT in `whitelist` access admin, by adding it to the `inspections` config:
```php
Route::group(['middleware' => 'firewall.url'], function () {
Route::get('/admin', 'AdminController@index');
});
```
Available middlewares applicable to routes:
```php
firewall.all
firewall.agent
firewall.bot
firewall.geo
firewall.ip
firewall.lfi
firewall.php
firewall.referrer
firewall.rfi
firewall.session
firewall.sqli
firewall.swear
firewall.url
firewall.whitelist
firewall.xss
```
You may also define `routes` for each middleware in `config/firewall.php` and apply that middleware or `firewall.all` at the top of all routes.
## Notifications
Firewall will send a notification as soon as an attack has been detected. Emails entered in `notifications.email.to` config must be valid Laravel users in order to send notifications. Check out the Notifications documentation of Laravel for further information.
## Changelog
Please see [Releases](../../releases) for more information on what has changed recently.
## Contributing
Pull requests are more than welcome. You must follow the PSR coding standards.
## Security
Please review [our security policy](https://github.com/akaunting/laravel-firewall/security/policy) on how to report security vulnerabilities.
## Credits
- [Denis Duliçi](https://github.com/denisdulici)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [LICENSE](LICENSE.md) for more information.