tkaratug / laravel-domain-whitelist
A domain wwhitelist checker middleware.
Fund package maintenance!
tkaratug
Requires
- php: ^7.4|^8.0|^8.1|^8.2
- illuminate/support: ^8.0|^9.0|^10.0
- spatie/laravel-package-tools: ^1.4.3
Requires (Dev)
- orchestra/testbench: ^6.0|^7.0|^8.0
- phpunit/phpunit: ^9.0
This package is auto-updated.
Last update: 2024-08-19 18:15:14 UTC
README
Introduction
This package contains a middleware to check whether the origin domain is in the whitelist. If not it blocks the request.
Installation
You can install the package via composer:
composer require tkaratug/laravel-domain-whitelist
You can publish the config file with:
php artisan vendor:publish --provider="Tkaratug\LaravelDomainWhitelist\LaravelDomainWhitelistServiceProvider" --tag="domain-whitelist-config"
This is the contents of the published config file:
return [ /* |--------------------------------------------- | Domains to allow | Leave empty to allow all requests |--------------------------------------------- */ 'domains' => [ //'*.example.com', //'example.com', ], /* |--------------------------------------------- | Paths to exclude |--------------------------------------------- */ 'excludes' => [ //'/api/posts', ], ];
Usage
Packages comes with DomainWhitelist
middleware. You can register it in $routeMiddleware
in app/Http/Kernel.php
file:
protected $routeMiddleware = [ // ... 'domain_whitelist' => \Tkaratug\LaravelDomainWhitelist\Middlewares\DomainWhitelist::class, ];
Use the middleware in any of your routes.
Route::middleware('domain_whitelist')->get('/', [HomeController::class, 'index']);
Testing
composer test
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
License
The MIT License (MIT). Please see License File for more information.