Laravel Route Restrictor is a middleware package designed to restrict a entire site or specific routes using HTTP basic authentication. It is compatible with Laravel 5.1 or above.
- Run
composer require divineomega/laravel-route-restrictor. - Add
DivineOmega\LaravelRouteRestrictor\Providers\LaravelRouteRestrictorServiceProvider::classto the$providersarray in yourconfig/app.phpfile. - Run
php artisan vendor:publish --provider="DivineOmega\LaravelRouteRestrictor\Providers\LaravelRouteRestrictorServiceProvider". - Add
\DivineOmega\LaravelRouteRestrictor\Http\Middleware\BasicAuthentication::classto the$middlewarearray in yourapp/Http/Kernel.phpfile. - Add
'routeRestrictor' => \DivineOmega\LaravelRouteRestrictor\Http\Middleware\BasicAuthentication::classto the$routeMiddlewarearray in yourapp/Http/Kernel.phpfile. - Add
RewriteRule .* - [E=REMOTE_USER:%{HTTP:Authorization}]immediately belowRewriteEngine Onin yourpublic/.htaccessfile. This is required for web servers that are configured to use CGI as their PHP handler.
In order to restrict all routes in your Laravel application, just add the global username and password to your .env file as follows. Ensure you change the username and password values.
ROUTE_RESTRICTOR_GLOBAL_USERNAME=username ROUTE_RESTRICTOR_GLOBAL_PASSWORD=password Your entire application will then be protected by these details, unless a route specific restriction is in place.
Alternatively, you can modify the global restriction username and password in your config/laravel-route-restrictor.php configuration file.
To restrict specific routes, you must edit your routing file at app/Http/routes.php. Simply surround the route or routes you want to restrict with the following route group code. Ensure you change the username and password middleware parameters.
Route::group(['middleware' => 'routeRestrictor:username,password'], function () { // Route(s) to restrict go here });Note: If you have both route specific restrictions and a global restriction, both will work, but route specific restrictions will take priority.
If you wish to exclude one or more routes from restriction, you must edit your routing file at app/Http/routes.php. Simply surround the route or routes you want to exclude with the following route group code.
Route::group(['middleware' => 'routeRestrictor:disable'], function () { // Route(s) to exclude from restriction go here });